Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_ImplementationGuide_R5

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-ImplementationGuide Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_ImplementationGuide_R5

This cross-version profile allows R4 ImplementationGuide content to be represented via FHIR R5 ImplementationGuide resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImplementationGuide C 0..* ImplementationGuide(5.0.0) A set of rules about how FHIR is used
Constraints: cnl-0, ig-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... name ΣC 1..1 string Name for this implementation guide (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... packageId Σ 1..1 id NPM Package name for IG
... fhirVersion ΣC 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImplementationGuide.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
ImplementationGuide.​fhirVersion Base required FHIRVersion 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ImplementationGuide Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning ImplementationGuide.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error ImplementationGuide.implicitRules, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.name, ImplementationGuide.status, ImplementationGuide.packageId, ImplementationGuide.fhirVersion All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImplementationGuide.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ig-2 error ImplementationGuide If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide definition.resource.fhirVersion.all(%context.fhirVersion contains $this)

This structure is derived from ImplementationGuide

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImplementationGuide 0..* ImplementationGuide(5.0.0) A set of rules about how FHIR is used
... global
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R4: type additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.global.type
Binding: R4ResourceTypesForR5 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... definition
.... resource
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.resource.example
.... page
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:name 0..1 Reference(Cross-version Profile for R4.Binary for use in FHIR R5(0.1.0) | Binary) R4: Where to find that page additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.page.name
.... parameter
..... code
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:code 0..1 code R4: apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.parameter.code
Binding: GuideParameterCode (required): Code of parameter that is input to the guide.
... manifest
.... resource
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.manifest.resource.example

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImplementationGuide C 0..* ImplementationGuide(5.0.0) A set of rules about how FHIR is used
Constraints: cnl-0, ig-2
... id Σ 0..1 id 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
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
Constraints: cnl-1
... 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: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 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
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... 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/steward (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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this implementation guide is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 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: SPDXLicense (required): The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/).
... fhirVersion ΣC 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 1..1 code Type this profile applies to
Binding: ResourceType . (required): One of the resource types defined as part of this version of FHIR.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code R4: type additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.global.type
Binding: R4ResourceTypesForR5 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... profile Σ 1..1 canonical(StructureDefinition) Profile that all resources must conform to
... definition C 0..1 BackboneElement Information needed to build the IG
Constraints: ig-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... grouping C 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... name 1..1 string Descriptive name for the package
..... description 0..1 markdown Human readable text describing the package
.... resource C 0..* BackboneElement Resource in the implementation guide
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.resource.example
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... reference 1..1 Reference(Resource) Location of the resource
..... fhirVersion C 0..* code Versions this applies to (if different to IG)
Binding: FHIRVersion (required): All published FHIR Versions.
..... name 0..1 string Human readable name for the resource
..... description 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
Constraints: ig-3
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:name 0..1 Reference(Cross-version Profile for R4.Binary for use in FHIR R5(0.1.0) | Binary) R4: Where to find that page additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.page.name
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... source[x] C 0..1 Source for page
...... sourceUrl url
...... sourceString string
...... sourceMarkdown markdown
..... name 1..1 url Name of the page when published
..... title 1..1 string Short title shown for navigational assistance
..... generation C 1..1 code html | markdown | xml | generated
Binding: GuidePageGeneration (required): A code that indicates how the page is generated.
..... page 0..* See page (ImplementationGuide) 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code 1..1 Coding Code that identifies parameter
Binding: GuideParameterCode (extensible)
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:code 1..1 code R4: apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.parameter.code
Binding: GuideParameterCode (required): Code of parameter that is input to the guide.
Constraints: ext-1
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.manifest.resource.example
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... reference Σ 1..1 Reference(Resource) 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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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

Terminology Bindings

Path Status Usage ValueSet Version Source
ImplementationGuide.​language Base required All Languages 📍5.0.0 FHIR Std.
ImplementationGuide.​versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
ImplementationGuide.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
ImplementationGuide.​jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
ImplementationGuide.​license Base required S P D X License 📍5.0.0 FHIR Std.
ImplementationGuide.​fhirVersion Base required FHIRVersion 📍5.0.0 FHIR Std.
ImplementationGuide.​global.type Base required Resource Types . 📍5.0.0 tx.fhir.org
ImplementationGuide.​definition.resource.​fhirVersion Base required FHIRVersion 📍5.0.0 FHIR Std.
ImplementationGuide.​definition.page.generation Base required Guide Page Generation 📍5.0.0 FHIR Std.
ImplementationGuide.​definition.parameter.​code Base extensible Guide Parameter Code 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ImplementationGuide Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning ImplementationGuide.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error ImplementationGuide.meta, ImplementationGuide.implicitRules, ImplementationGuide.language, ImplementationGuide.text, ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.identifier, ImplementationGuide.version, ImplementationGuide.versionAlgorithm[x], ImplementationGuide.name, ImplementationGuide.title, ImplementationGuide.status, ImplementationGuide.experimental, ImplementationGuide.date, ImplementationGuide.publisher, ImplementationGuide.contact, ImplementationGuide.description, ImplementationGuide.useContext, ImplementationGuide.jurisdiction, ImplementationGuide.purpose, ImplementationGuide.copyright, ImplementationGuide.copyrightLabel, ImplementationGuide.packageId, ImplementationGuide.license, ImplementationGuide.fhirVersion, ImplementationGuide.dependsOn, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.dependsOn.uri, ImplementationGuide.dependsOn.packageId, ImplementationGuide.dependsOn.version, ImplementationGuide.dependsOn.reason, ImplementationGuide.global, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.global.profile, ImplementationGuide.definition, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.grouping.name, ImplementationGuide.definition.grouping.description, ImplementationGuide.definition.resource, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:example, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.resource.reference, ImplementationGuide.definition.resource.fhirVersion, ImplementationGuide.definition.resource.name, ImplementationGuide.definition.resource.description, ImplementationGuide.definition.resource.isExample, ImplementationGuide.definition.resource.profile, ImplementationGuide.definition.resource.groupingId, ImplementationGuide.definition.page, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.extension:name, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.page.source[x], ImplementationGuide.definition.page.name, ImplementationGuide.definition.page.title, ImplementationGuide.definition.page.generation, ImplementationGuide.definition.page.page, ImplementationGuide.definition.parameter, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.parameter.code, ImplementationGuide.definition.parameter.code.extension, ImplementationGuide.definition.parameter.code.extension:code, ImplementationGuide.definition.parameter.code.system, ImplementationGuide.definition.parameter.code.version, ImplementationGuide.definition.parameter.code.code, ImplementationGuide.definition.parameter.code.display, ImplementationGuide.definition.parameter.code.userSelected, ImplementationGuide.definition.parameter.value, ImplementationGuide.definition.template, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.definition.template.code, ImplementationGuide.definition.template.source, ImplementationGuide.definition.template.scope, ImplementationGuide.manifest, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.rendering, ImplementationGuide.manifest.resource, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.extension:example, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.resource.reference, ImplementationGuide.manifest.resource.isExample, ImplementationGuide.manifest.resource.profile, ImplementationGuide.manifest.resource.relativePath, ImplementationGuide.manifest.page, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.modifierExtension, ImplementationGuide.manifest.page.name, ImplementationGuide.manifest.page.title, ImplementationGuide.manifest.page.anchor, ImplementationGuide.manifest.image, ImplementationGuide.manifest.other All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:example, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.extension:name, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.parameter.code.extension, ImplementationGuide.definition.parameter.code.extension:code, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.extension:example, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ig-1 error ImplementationGuide.definition If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide resource.groupingId.all(%context.grouping.id contains $this)
ig-2 error ImplementationGuide If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide definition.resource.fhirVersion.all(%context.fhirVersion contains $this)
ig-3 error ImplementationGuide.definition.page Source must be absent if 'generated' is generated generation='generated' implies source.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImplementationGuide C 0..* ImplementationGuide(5.0.0) A set of rules about how FHIR is used
Constraints: cnl-0, ig-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... name ΣC 1..1 string Name for this implementation guide (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... packageId Σ 1..1 id NPM Package name for IG
... fhirVersion ΣC 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImplementationGuide.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
ImplementationGuide.​fhirVersion Base required FHIRVersion 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ImplementationGuide Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning ImplementationGuide.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error ImplementationGuide.implicitRules, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.name, ImplementationGuide.status, ImplementationGuide.packageId, ImplementationGuide.fhirVersion All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImplementationGuide.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ig-2 error ImplementationGuide If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide definition.resource.fhirVersion.all(%context.fhirVersion contains $this)

Differential View

This structure is derived from ImplementationGuide

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImplementationGuide 0..* ImplementationGuide(5.0.0) A set of rules about how FHIR is used
... global
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code R4: type additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.global.type
Binding: R4ResourceTypesForR5 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... definition
.... resource
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.resource.example
.... page
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:name 0..1 Reference(Cross-version Profile for R4.Binary for use in FHIR R5(0.1.0) | Binary) R4: Where to find that page additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.page.name
.... parameter
..... code
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:code 0..1 code R4: apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.parameter.code
Binding: GuideParameterCode (required): Code of parameter that is input to the guide.
... manifest
.... resource
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.manifest.resource.example

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImplementationGuide C 0..* ImplementationGuide(5.0.0) A set of rules about how FHIR is used
Constraints: cnl-0, ig-2
... id Σ 0..1 id 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
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
Constraints: cnl-1
... 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: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 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
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... 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/steward (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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this implementation guide is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 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: SPDXLicense (required): The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/).
... fhirVersion ΣC 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 1..1 code Type this profile applies to
Binding: ResourceType . (required): One of the resource types defined as part of this version of FHIR.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code R4: type additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.global.type
Binding: R4ResourceTypesForR5 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... profile Σ 1..1 canonical(StructureDefinition) Profile that all resources must conform to
... definition C 0..1 BackboneElement Information needed to build the IG
Constraints: ig-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... grouping C 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... name 1..1 string Descriptive name for the package
..... description 0..1 markdown Human readable text describing the package
.... resource C 0..* BackboneElement Resource in the implementation guide
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.resource.example
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... reference 1..1 Reference(Resource) Location of the resource
..... fhirVersion C 0..* code Versions this applies to (if different to IG)
Binding: FHIRVersion (required): All published FHIR Versions.
..... name 0..1 string Human readable name for the resource
..... description 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
Constraints: ig-3
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:name 0..1 Reference(Cross-version Profile for R4.Binary for use in FHIR R5(0.1.0) | Binary) R4: Where to find that page additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.page.name
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... source[x] C 0..1 Source for page
...... sourceUrl url
...... sourceString string
...... sourceMarkdown markdown
..... name 1..1 url Name of the page when published
..... title 1..1 string Short title shown for navigational assistance
..... generation C 1..1 code html | markdown | xml | generated
Binding: GuidePageGeneration (required): A code that indicates how the page is generated.
..... page 0..* See page (ImplementationGuide) 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code 1..1 Coding Code that identifies parameter
Binding: GuideParameterCode (extensible)
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:code 1..1 code R4: apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.parameter.code
Binding: GuideParameterCode (required): Code of parameter that is input to the guide.
Constraints: ext-1
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:example 0..1 boolean, canonical(Cross-version Profile for R4.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) R4: Is an example/What is this an example of? (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.manifest.resource.example
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... reference Σ 1..1 Reference(Resource) 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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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

Terminology Bindings

Path Status Usage ValueSet Version Source
ImplementationGuide.​language Base required All Languages 📍5.0.0 FHIR Std.
ImplementationGuide.​versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
ImplementationGuide.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
ImplementationGuide.​jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
ImplementationGuide.​license Base required S P D X License 📍5.0.0 FHIR Std.
ImplementationGuide.​fhirVersion Base required FHIRVersion 📍5.0.0 FHIR Std.
ImplementationGuide.​global.type Base required Resource Types . 📍5.0.0 tx.fhir.org
ImplementationGuide.​definition.resource.​fhirVersion Base required FHIRVersion 📍5.0.0 FHIR Std.
ImplementationGuide.​definition.page.generation Base required Guide Page Generation 📍5.0.0 FHIR Std.
ImplementationGuide.​definition.parameter.​code Base extensible Guide Parameter Code 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ImplementationGuide Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning ImplementationGuide.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error ImplementationGuide.meta, ImplementationGuide.implicitRules, ImplementationGuide.language, ImplementationGuide.text, ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.identifier, ImplementationGuide.version, ImplementationGuide.versionAlgorithm[x], ImplementationGuide.name, ImplementationGuide.title, ImplementationGuide.status, ImplementationGuide.experimental, ImplementationGuide.date, ImplementationGuide.publisher, ImplementationGuide.contact, ImplementationGuide.description, ImplementationGuide.useContext, ImplementationGuide.jurisdiction, ImplementationGuide.purpose, ImplementationGuide.copyright, ImplementationGuide.copyrightLabel, ImplementationGuide.packageId, ImplementationGuide.license, ImplementationGuide.fhirVersion, ImplementationGuide.dependsOn, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.dependsOn.uri, ImplementationGuide.dependsOn.packageId, ImplementationGuide.dependsOn.version, ImplementationGuide.dependsOn.reason, ImplementationGuide.global, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.global.profile, ImplementationGuide.definition, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.grouping.name, ImplementationGuide.definition.grouping.description, ImplementationGuide.definition.resource, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:example, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.resource.reference, ImplementationGuide.definition.resource.fhirVersion, ImplementationGuide.definition.resource.name, ImplementationGuide.definition.resource.description, ImplementationGuide.definition.resource.isExample, ImplementationGuide.definition.resource.profile, ImplementationGuide.definition.resource.groupingId, ImplementationGuide.definition.page, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.extension:name, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.page.source[x], ImplementationGuide.definition.page.name, ImplementationGuide.definition.page.title, ImplementationGuide.definition.page.generation, ImplementationGuide.definition.page.page, ImplementationGuide.definition.parameter, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.parameter.code, ImplementationGuide.definition.parameter.code.extension, ImplementationGuide.definition.parameter.code.extension:code, ImplementationGuide.definition.parameter.code.system, ImplementationGuide.definition.parameter.code.version, ImplementationGuide.definition.parameter.code.code, ImplementationGuide.definition.parameter.code.display, ImplementationGuide.definition.parameter.code.userSelected, ImplementationGuide.definition.parameter.value, ImplementationGuide.definition.template, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.definition.template.code, ImplementationGuide.definition.template.source, ImplementationGuide.definition.template.scope, ImplementationGuide.manifest, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.rendering, ImplementationGuide.manifest.resource, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.extension:example, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.resource.reference, ImplementationGuide.manifest.resource.isExample, ImplementationGuide.manifest.resource.profile, ImplementationGuide.manifest.resource.relativePath, ImplementationGuide.manifest.page, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.modifierExtension, ImplementationGuide.manifest.page.name, ImplementationGuide.manifest.page.title, ImplementationGuide.manifest.page.anchor, ImplementationGuide.manifest.image, ImplementationGuide.manifest.other All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:example, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.extension:name, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.parameter.code.extension, ImplementationGuide.definition.parameter.code.extension:code, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.extension:example, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
ig-1 error ImplementationGuide.definition If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide resource.groupingId.all(%context.grouping.id contains $this)
ig-2 error ImplementationGuide If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide definition.resource.fhirVersion.all(%context.fhirVersion contains $this)
ig-3 error ImplementationGuide.definition.page Source must be absent if 'generated' is generated generation='generated' implies source.empty()

 

Other representations of profile: CSV, Excel, Schematron