ImplementationGuide
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.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| url | Yes | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) |
| version | No | string | Business version of the implementation guide |
| name | Yes | string | Name for this implementation guide (computer friendly) |
| title | No | string | Name for this implementation guide (human friendly) |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | ContactDetail[] | Contact details for the publisher |
| description | No | markdown | Natural language description of the implementation guide |
| useContext | No | UsageContext[] | The context that the content is intended to support |
| jurisdiction | No | CodeableConcept[] | Intended jurisdiction for implementation guide (if applicable) |
| copyright | No | markdown | Use and/or publishing restrictions |
| packageId | Yes | id | NPM Package name for IG |
| license | No | code | SPDX license code for this IG (or not-open-source) |
| fhirVersion | Yes | code[] | FHIR Version(s) this Implementation Guide targets |
| dependsOn | No | ImplementationGuideDependsOn | Another Implementation guide this depends on |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - uri | Yes | canonical | Identity of the IG that this depends on |
| - packageId | No | id | NPM Package name for IG this depends on |
| - version | No | string | Version of the IG |
| global | No | ImplementationGuideGlobal | Profiles that apply globally |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - type | Yes | code | Type this profile applies to |
| - profile | Yes | canonical | Profile that all resources must conform to |
| definition | No | ImplementationGuideDefinition | Information needed to build the IG |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - grouping | No | ImplementationGuideDefinitionGrouping | Grouping used to present related resources in the IG |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - name | Yes | string | Descriptive name for the package |
| - description | No | string | Human readable text describing the package |
| - resource | Yes | ImplementationGuideDefinitionResource | Resource in the implementation guide |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - reference | Yes | Reference<Resource> | Location of the resource |
| - fhirVersion | No | code[] | Versions this applies to (if different to IG) |
| - name | No | string | Human Name for the resource |
| - description | No | string | Reason why included in guide |
| - example[x] | No | boolean, canonical | Is an example/What is this an example of? |
| - groupingId | No | id | Grouping this is part of |
| - page | No | ImplementationGuideDefinitionPage | Page/Section in the Guide |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - name[x] | Yes | url, Reference<Binary> | Where to find that page |
| - title | Yes | string | Short title shown for navigational assistance |
| - generation | Yes | code | html / markdown / xml / generated |
| - page | No | [] | Nested Pages / Sections |
| - parameter | No | ImplementationGuideDefinitionParameter | Defines how IG is built by tools |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - code | Yes | code | apply / path-resource / path-pages / path-tx-cache / expansion-parameter / rule-broken-links / generate-xml / generate-json / generate-turtle / html-template |
| - value | Yes | string | Value for named type |
| - template | No | ImplementationGuideDefinitionTemplate | A template for building resources |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - code | Yes | code | Type of template specified |
| - source | Yes | string | The source location for the template |
| - scope | No | string | The scope in which the template applies |
| manifest | No | ImplementationGuideManifest | Information about an assembled IG |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - rendering | No | url | Location of rendered implementation guide |
| - resource | Yes | ImplementationGuideManifestResource | Resource in the implementation guide |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - reference | Yes | Reference<Resource> | Location of the resource |
| - example[x] | No | boolean, canonical | Is an example/What is this an example of? |
| - relativePath | No | url | Relative path for page in IG |
| - page | No | ImplementationGuideManifestPage | HTML page within the parent IG |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - name | Yes | string | HTML page name |
| - title | No | string | Title of the page, for references |
| - anchor | No | string[] | Anchor available on the page |
| - image | No | string[] | Image within the IG |
| - other | No | string[] | Additional linkable file in IG |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| context | token | A use context assigned to the implementation guide | ImplementationGuide.useContext.value |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the implementation guide | ImplementationGuide.useContext.value |
| context-type | token | A type of use context assigned to the implementation guide | ImplementationGuide.useContext.code |
| date | date | The implementation guide publication date | ImplementationGuide.date |
| description | string | The description of the implementation guide | ImplementationGuide.description |
| 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 |
| 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 |
| 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 |
| depends-on | reference | Identity of the IG that this depends on | ImplementationGuide.dependsOn.uri |
| experimental | token | For testing purposes, not real usage | ImplementationGuide.experimental |
| global | reference | Profile that all resources must conform to | ImplementationGuide.global.profile |
| resource | reference | Location of the resource | ImplementationGuide.definition.resource.reference |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see ImplementationGuide.