This is the set of resources that conform to either of the profiles CPG Computable Guideline (http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-computableguideline) and CPG Computable Guideline (http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-computableguideline). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImplementationGuide | C | 0..* | A set of rules about how FHIR is used dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ig-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ig-2: If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide | |
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | Σ | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Business version of the implementation guide ele-1: All FHIR elements must have a @value or children |
name | Σ | 1..1 | string | Name for this implementation guide (computer friendly) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Name for this implementation guide (human friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
date | Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
description | 0..1 | markdown | Natural language description of the implementation guide ele-1: All FHIR elements must have a @value or children | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for implementation guide (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
copyright | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children | |
packageId | Σ | 1..1 | id | NPM Package name for IG ele-1: All FHIR elements must have a @value or children |
license | Σ | 0..1 | code | SPDX license code for this IG (or not-open-source) Binding: ?? (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/). ele-1: All FHIR elements must have a @value or children |
fhirVersion | Σ | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: ?? (required): All published FHIR Versions. ele-1: All FHIR elements must have a @value or children |
dependsOn | SΣ | 0..* | BackboneElement | Another Implementation guide this depends on ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
uri | Σ | 1..1 | canonical(ImplementationGuide) | Identity of the IG that this depends on ele-1: All FHIR elements must have a @value or children |
packageId | Σ | 0..1 | id | NPM Package name for IG this depends on ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Version of the IG ele-1: All FHIR elements must have a @value or children |
global | Σ | 0..* | BackboneElement | Profiles that apply globally ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | Σ | 1..1 | code | Type this profile applies to Binding: ?? (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children |
profile | Σ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to ele-1: All FHIR elements must have a @value or children |
definition | SC | 0..1 | BackboneElement | Information needed to build the IG ele-1: All FHIR elements must have a @value or children ig-1: If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
grouping | 0..* | BackboneElement | Grouping used to present related resources in the IG ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | 1..1 | string | Descriptive name for the package ele-1: All FHIR elements must have a @value or children | |
description | 0..1 | string | Human readable text describing the package ele-1: All FHIR elements must have a @value or children | |
resource | 1..* | BackboneElement | Resource in the implementation guide ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | 1..1 | Reference(Resource) | Location of the resource ele-1: All FHIR elements must have a @value or children | |
fhirVersion | 0..* | code | Versions this applies to (if different to IG) Binding: ?? (required): All published FHIR Versions. ele-1: All FHIR elements must have a @value or children | |
name | 0..1 | string | Human Name for the resource ele-1: All FHIR elements must have a @value or children | |
description | 0..1 | string | Reason why included in guide ele-1: All FHIR elements must have a @value or children | |
example[x] | 0..1 | Is an example/What is this an example of? ele-1: All FHIR elements must have a @value or children | ||
exampleBoolean | boolean | |||
exampleCanonical | canonical(StructureDefinition) | |||
groupingId | 0..1 | id | Grouping this is part of ele-1: All FHIR elements must have a @value or children | |
page | 0..1 | BackboneElement | Page/Section in the Guide ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name[x] | 1..1 | Where to find that page ele-1: All FHIR elements must have a @value or children | ||
nameUrl | url | |||
nameReference | Reference(Binary) | |||
title | 1..1 | string | Short title shown for navigational assistance ele-1: All FHIR elements must have a @value or children | |
generation | 1..1 | code | html | markdown | xml | generated Binding: ?? (required): A code that indicates how the page is generated. ele-1: All FHIR elements must have a @value or children | |
page | 0..* | Nested Pages / Sections ele-1: All FHIR elements must have a @value or children | ||
parameter | 0..* | BackboneElement | Defines how IG is built by tools ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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 Binding: ?? (required): Code of parameter that is input to the guide. ele-1: All FHIR elements must have a @value or children | |
value | 1..1 | string | Value for named type ele-1: All FHIR elements must have a @value or children | |
template | 0..* | BackboneElement | A template for building resources ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | 1..1 | code | Type of template specified ele-1: All FHIR elements must have a @value or children | |
source | 1..1 | string | The source location for the template ele-1: All FHIR elements must have a @value or children | |
scope | 0..1 | string | The scope in which the template applies ele-1: All FHIR elements must have a @value or children | |
manifest | 0..1 | BackboneElement | Information about an assembled IG ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
rendering | Σ | 0..1 | url | Location of rendered implementation guide ele-1: All FHIR elements must have a @value or children |
resource | Σ | 1..* | BackboneElement | Resource in the implementation guide ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | Σ | 1..1 | Reference(Resource) | Location of the resource ele-1: All FHIR elements must have a @value or children |
example[x] | 0..1 | Is an example/What is this an example of? ele-1: All FHIR elements must have a @value or children | ||
exampleBoolean | boolean | |||
exampleCanonical | canonical(StructureDefinition) | |||
relativePath | 0..1 | url | Relative path for page in IG ele-1: All FHIR elements must have a @value or children | |
page | 0..* | BackboneElement | HTML page within the parent IG ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | 1..1 | string | HTML page name ele-1: All FHIR elements must have a @value or children | |
title | 0..1 | string | Title of the page, for references ele-1: All FHIR elements must have a @value or children | |
anchor | 0..* | string | Anchor available on the page ele-1: All FHIR elements must have a @value or children | |
image | 0..* | string | Image within the IG ele-1: All FHIR elements must have a @value or children | |
other | 0..* | string | Additional linkable file in IG ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |