Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImplementationGuide | TU | DomainResource | A set of rules about how FHIR is used
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource |
|
url | Σ C | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Additional identifier for the implementation guide (business identifier)
|
version | Σ | 0..1 | string | Business version of the implementation guide
|
versionAlgorithm[x] | Σ | 0..1 | How to compare versions
Binding: Version Algorithm ( Extensible) |
|
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ C | 1..1 | string | Name for this implementation guide (computer friendly)
|
title | Σ T | 0..1 | string | Name for this implementation guide (human friendly)
|
status | ?! Σ | 1..1 | code | draft | active | retired | unknown
Binding: PublicationStatus ( Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
|
date | Σ | 0..1 | dateTime | Date last changed
|
publisher | Σ T | 0..1 | string | Name of the publisher/steward (organization or individual)
|
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
|
description | T | 0..1 | markdown | Natural language description of the implementation guide
|
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
|
jurisdiction | Σ XD | 0..* | CodeableConcept | Intended jurisdiction for implementation guide (if applicable)
Binding: Jurisdiction ValueSet ( Extensible) |
purpose | T | 0..1 | markdown | Why this implementation guide is defined
|
copyright | T | 0..1 | markdown | Use and/or publishing restrictions
|
copyrightLabel | T | 0..1 | string | Copyright holder and year(s)
|
packageId | Σ | 1..1 | id | NPM Package name for IG
|
license | Σ | 0..1 | code | SPDX license code for this IG (or not-open-source)
Binding: S P D X License ( Required) |
fhirVersion | Σ C | 1..* | code | FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion ( Required) |
dependsOn | Σ | 0..* | BackboneElement | Another Implementation guide this depends on
|
uri | Σ | 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
|
reason | 0..1 | markdown | Why dependency exists
|
|
global | Σ | 0..* | BackboneElement | Profiles that apply globally
|
type | Σ | 1..1 | code | Type this profile applies to
Binding: Resource Types ( Required) |
profile | Σ | 1..1 | canonical( StructureDefinition) | Profile that all resources must conform to
|
definition | C | 0..1 | BackboneElement | Information needed to build the IG
+ Rule: If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide |
grouping | C | 0..* | BackboneElement | Grouping used to present related resources in the IG
|
name | T | 1..1 | string | Descriptive name for the package
|
description | T | 0..1 | markdown | Human readable text describing the package
|
resource | C | 0..* | BackboneElement | Resource in the implementation guide
|
reference | 1..1 | Reference( Any) | Location of the resource
|
|
fhirVersion | C | 0..* | code | Versions this applies to (if different to IG)
Binding: FHIRVersion ( Required) |
name | T | 0..1 | string | Human readable name for the resource
|
description | T | 0..1 | markdown | Reason why included in guide
|
isExample | 0..1 | boolean | Is this an example
|
|
profile | 0..* | canonical( StructureDefinition) | Profile(s) this is an example of
|
|
groupingId | C | 0..1 | id | Grouping this is part of
|
page | C | 0..1 | BackboneElement | Page/Section in the Guide
+ Rule: Source must be absent if 'generated' is generated |
source[x] | T C | 0..1 | Source for page
|
|
sourceUrl | url | |||
sourceString | string | |||
sourceMarkdown | markdown | |||
name | 1..1 | url | Name of the page when published
|
|
title | T | 1..1 | string | Short title shown for navigational assistance
|
generation | C | 1..1 | code | html | markdown | xml | generated
Binding: Guide Page Generation ( Required) |
page | 0..* | see page | Nested Pages / Sections
|
|
parameter | 0..* | BackboneElement | Defines how IG is built by tools
|
|
code | 1..1 | Coding | Code that identifies parameter
Binding: Guide Parameter Code ( Extensible) |
|
value | 1..1 | string | Value for named type
|
|
template | 0..* | BackboneElement | A template for building resources
|
|
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
|
|
rendering | Σ | 0..1 | url | Location of rendered implementation guide
|
resource | Σ | 1..* | BackboneElement | Resource in the implementation guide
|
reference | Σ | 1..1 | Reference( Any) | Location of the resource
|
isExample | 0..1 | boolean | Is this an example
|
|
profile | 0..* | canonical( StructureDefinition) | Profile(s) this is an example of
|
|
relativePath | 0..1 | url | Relative path for page in IG
|
|
page | 0..* | BackboneElement | HTML page within the parent IG
|
|
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
|
|
Documentation for this format |