ImplementationGuide
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 16 of 18 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlRequiredΣ | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) |
versionΣ | 0..1 | string | Business version of the implementation guide |
nameRequiredΣ | 1..1 | string | Name for this implementation guide (computer friendly) |
titleΣ | 0..1 | string | Name for this implementation guide (human friendly) |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
dateΣ | 0..1 | dateTime | Date last changed |
publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
contactΣ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the implementation guide |
useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for implementation guide (if applicable)Binding (extensible): jurisdiction |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
packageIdRequiredΣ | 1..1 | id | NPM Package name for IG |
licenseΣ | 0..1 | code | SPDX license code for this IG (or not-open-source)Binding (required): spdx-license |
fhirVersionRequiredΣ | 1..* | code | FHIR Version(s) this Implementation Guide targetsBinding (required): FHIR-version |
dependsOnΣ | 0..* | BackboneElement | Another Implementation guide this depends on |
uriRequiredΣ | 1..1 | canonical(ImplementationGuide) | Identity of the IG that this depends on |
packageIdΣ | 0..1 | id | NPM Package name for IG this depends on |
versionΣ | 0..1 | string | Version of the IG |
globalΣ | 0..* | BackboneElement | Profiles that apply globally |
typeRequiredΣ | 1..1 | code | Type this profile applies toBinding (required): resource-types |
profileRequiredΣ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to |
definition | 0..1 | BackboneElement | Information needed to build the IG |
grouping | 0..* | BackboneElement | Grouping used to present related resources in the IG |
nameRequired | 1..1 | string | Descriptive name for the package |
description | 0..1 | string | Human readable text describing the package |
resourceRequired | 1..* | BackboneElement | Resource in the implementation guide |
referenceRequired | 1..1 | Reference(Resource) | Location of the resource |
fhirVersion | 0..* | code | Versions this applies to (if different to IG)Binding (required): FHIR-version |
name | 0..1 | string | Human Name for the resource |
description | 0..1 | string | Reason why included in guide |
example[x] | 0..1 | boolean | canonical(StructureDefinition) | Is an example/What is this an example of? |
groupingId | 0..1 | id | Grouping this is part of |
page | 0..1 | BackboneElement | Page/Section in the Guide |
name[x]Required | 1..1 | url | Reference(Binary) | Where to find that page |
titleRequired | 1..1 | string | Short title shown for navigational assistance |
generationRequired | 1..1 | code | html | markdown | xml | generatedBinding (required): guide-page-generation |
page | 0..* | Same as ImplementationGuide.definition.page | Nested Pages / Sections |
parameter | 0..* | BackboneElement | Defines how IG is built by tools |
codeRequired | 1..1 | code | apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-templateBinding (required): guide-parameter-code |
valueRequired | 1..1 | string | Value for named type |
template | 0..* | BackboneElement | A template for building resources |
codeRequired | 1..1 | code | Type of template specified |
sourceRequired | 1..1 | string | The source location for the template |
scope | 0..1 | string | The scope in which the template applies |
manifest | 0..1 | BackboneElement | Information about an assembled IG |
renderingΣ | 0..1 | url | Location of rendered implementation guide |
resourceRequiredΣ | 1..* | BackboneElement | Resource in the implementation guide |
referenceRequiredΣ | 1..1 | Reference(Resource) | Location of the resource |
example[x] | 0..1 | boolean | canonical(StructureDefinition) | Is an example/What is this an example of? |
relativePath | 0..1 | url | Relative path for page in IG |
page | 0..* | BackboneElement | HTML page within the parent IG |
nameRequired | 1..1 | string | HTML page name |
title | 0..1 | string | Title of the page, for references |
anchor | 0..* | string | Anchor available on the page |
image | 0..* | string | Image within the IG |
other | 0..* | string | Additional linkable file in IG |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/ImplementationGuide?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
context | token | A use context assigned to the implementation guide (ImplementationGuide.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the implementation guide (ImplementationGuide.useContext.value.ofType(Quantity)) | (ImplementationGuide.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the implementation guide ImplementationGuide.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the implementation guide ImplementationGuide.useContext | ||
context-type-value | composite | A use context type and value assigned to the implementation guide ImplementationGuide.useContext | ||
date | date | The implementation guide publication date ImplementationGuide.date | ||
depends-on | reference | Identity of the IG that this depends on ImplementationGuide.dependsOn.uri | ||
description | string | The description of the implementation guide ImplementationGuide.description | ||
experimental | token | For testing purposes, not real usage ImplementationGuide.experimental | ||
global | reference | Profile that all resources must conform to ImplementationGuide.global.profile | ||
jurisdiction | token | Intended jurisdiction for the implementation guide ImplementationGuide.jurisdiction | ||
name | string | Computationally friendly name of the implementation guide ImplementationGuide.name | ||
publisher | string | Name of the publisher of the implementation guide ImplementationGuide.publisher | ||
resource | reference | Location of the resource ImplementationGuide.definition.resource.reference | ||
status | token | The current status of the implementation guide ImplementationGuide.status | ||
title | string | The human-friendly name of the implementation guide ImplementationGuide.title | ||
url | uri | The uri that identifies the implementation guide ImplementationGuide.url | ||
version | token | The business version of the implementation guide ImplementationGuide.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken