ImplementationGuide
FoundationA 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.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| ImplementationGuide | 0..* | — | A set of rules about how FHIR is used |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 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 |
| .nameΣ | 1..1 | string | Name for this implementation guide (computer friendly) |
| .titleΣ | 0..1 | string | Name for this implementation guide (human friendly) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .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) Bindingjurisdiction(extensible) |
| .copyright | 0..1 | markdown | Use and/or publishing restrictions |
| .packageIdΣ | 1..1 | id | NPM Package name for IG |
| .licenseΣ | 0..1 | code | SPDX license code for this IG (or not-open-source) Bindingspdx-license(required) |
| .fhirVersionΣ | 1..* | code | FHIR Version(s) this Implementation Guide targets BindingFHIR-version(required) |
| .dependsOnΣ | 0..* | BackboneElement | Another Implementation guide this depends on |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .uriΣ | 1..1 | canonical | 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 |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .typeΣ | 1..1 | code | Type this profile applies to Bindingresource-types(required) |
| .profileΣ | 1..1 | canonical | Profile that all resources must conform to |
| .definition | 0..1 | BackboneElement | Information needed to build the IG |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .grouping | 0..* | BackboneElement | Grouping used to present related resources in the IG |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .name | 1..1 | string | Descriptive name for the package |
| .description | 0..1 | string | Human readable text describing the package |
| .resource | 1..* | BackboneElement | Resource in the implementation guide |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .reference | 1..1 | Reference(Resource) | Location of the resource |
| .fhirVersion | 0..* | code | Versions this applies to (if different to IG) BindingFHIR-version(required) |
| .name | 0..1 | string | Human Name for the resource |
| .description | 0..1 | string | Reason why included in guide |
| .example[x] | 0..1 | boolean | canonical | 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 |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .name[x] | 1..1 | url | Reference(Binary) | Where to find that page |
| .title | 1..1 | string | Short title shown for navigational assistance |
| .generation | 1..1 | code | html | markdown | xml | generated Bindingguide-page-generation(required) |
| .page | 0..* | — | Nested Pages / Sections |
| .parameter | 0..* | BackboneElement | Defines how IG is built by tools |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .code | 1..1 | code | apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template Bindingguide-parameter-code(required) |
| .value | 1..1 | string | Value for named type |
| .template | 0..* | BackboneElement | A template for building resources |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .code | 1..1 | code | Type of template specified |
| .source | 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 |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .renderingΣ | 0..1 | url | Location of rendered implementation guide |
| .resourceΣ | 1..* | BackboneElement | Resource in the implementation guide |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .referenceΣ | 1..1 | Reference(Resource) | Location of the resource |
| .example[x] | 0..1 | boolean | canonical | 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 |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .name | 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 |