Name Flags Card. Type Description & Constraints doco
. . ImplementationGuide I 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 oe of the versions defined for the Implementation Guide
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . 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 Σ I 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
PublicationStatus (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)
Jurisdiction (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)
SPDXLicense (Required)
. . . fhirVersion Σ 1..* code FHIR Version(s) this Implementation Guide targets
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
. . . global Σ 0..* BackboneElement Profiles that apply globally
. . . . type Σ 1..1 code Type this profile applies to
ResourceType (Required)
. . . . profile Σ 1..1 canonical(StructureDefinition) Profile that all resources must conform to
. . . definition I 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 0..* BackboneElement Grouping used to present related resources in the IG
. . . . . 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
. . . . . reference 1..1 Reference(Any) Location of the resource
. . . . . fhirVersion 0..* code Versions this applies to (if different to IG)
FHIRVersion (Required)
. . . . . name 0..1 string Human Name for the resource
. . . . . description 0..1 string Reason why included in guide
. . . . . example[x] 0..1 Is an example/What is this an example of?
. . . . . . exampleBoolean boolean
. . . . . . exampleCanonical canonical(StructureDefinition)
. . . . . groupingId 0..1 id Grouping this is part of
. . . . page 0..1 BackboneElement Page/Section in the Guide
. . . . . name[x] 1..1 Where to find that page
. . . . . . nameUrl url
. . . . . . nameReference Reference(Binary)
. . . . . title 1..1 string Short title shown for navigational assistance
. . . . . generation 1..1 code html | markdown | xml | generated
GuidePageGeneration (Required)
. . . . . page 0..* see page Nested Pages / Sections
. . . . parameter 0..* BackboneElement Defines how IG is built by tools
. . . . . 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
GuideParameterCode (Required)
. . . . . 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
. . . . . example[x] 0..1 Is an example/What is this an example of?
. . . . . . exampleBoolean boolean
. . . . . . exampleCanonical canonical(StructureDefinition)
. . . . . 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

doco Documentation for this format