Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-ImplementationGuide resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImplementationGuide | |
| Definition | 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. |
| Short | A set of rules about how FHIR is used |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | cnl-0: 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}$'))ig-2: 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))cnl-0: 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}$')) ig-2: 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)) |
| 2. ImplementationGuide.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. ImplementationGuide.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 6. ImplementationGuide.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 8. ImplementationGuide.url | |
| Definition | An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers. |
| Short | Canonical identifier for this implementation guide, represented as a URI (globally unique) |
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process. |
| Alternate Names | url, authoritative-url, destination, identity |
| Invariants | cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()))cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$')) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. ImplementationGuide.name | |
| Definition | A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Short | Name for this implementation guide (computer friendly) |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
| Control | 1..1 This element is affected by the following invariants: cnl-0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Support human navigation and code generation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. ImplementationGuide.status | |
| Definition | The status of this implementation guide. Enables tracking the life-cycle of the content. |
| Short | draft | active | retired | unknown |
| Comments | Allows filtering of implementation guides that are appropriate for use versus not. See guidance around (not) making local changes to elements here. Allows filtering of implementation guides that are appropriate for use versus not. See guidance around (not) making local changes to elements here. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)The lifecycle status of an artifact. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. ImplementationGuide.packageId | |
| Definition | The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care. |
| Short | NPM Package name for IG |
| Comments | Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs. |
| Control | 1..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. ImplementationGuide.fhirVersion | |
| Definition | The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version. |
| Short | FHIR Version(s) this Implementation Guide targets |
| Comments | Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc. are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics. |
| Control | 1..* This element is affected by the following invariants: ig-2 |
| Binding | The codes SHALL be taken from FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 (required to http://hl7.org/fhir/ValueSet/FHIR-version|5.0.0)All published FHIR Versions. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImplementationGuide | |
| 2. ImplementationGuide.meta | |
| 4. ImplementationGuide.meta.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. ImplementationGuide.meta.extension:meta | |
| Slice Name | meta |
| Definition | DSTU2: |
| Short | DSTU2: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: meta additional types) (Extension Type: Meta) |
| 8. ImplementationGuide.text | |
| 10. ImplementationGuide.text.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. ImplementationGuide.text.extension:text | |
| Slice Name | text |
| Definition | DSTU2: |
| Short | DSTU2: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: text additional types) (Complex Extension) |
| 14. ImplementationGuide.contact | |
| 16. ImplementationGuide.contact.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. ImplementationGuide.contact.extension:name | |
| Slice Name | name |
| Definition | DSTU2: |
| Short | DSTU2: Name of a individual to contact (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Name of a individual to contact (new)) (Extension Type: string) |
| 20. ImplementationGuide.contact.extension:telecom | |
| Slice Name | telecom |
| Definition | DSTU2: |
| Short | DSTU2: Contact details for individual or publisher (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contact details for individual or publisher (new)) (Extension Type: ContactPoint) |
| 22. ImplementationGuide.dependsOn | |
| 24. ImplementationGuide.dependsOn.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.dependsOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. ImplementationGuide.dependsOn.extension:type | |
| Slice Name | type |
| Definition | DSTU2: |
| Short | DSTU2: reference | inclusion (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: reference | inclusion (new)) (Extension Type: code) |
| 28. ImplementationGuide.global | |
| 30. ImplementationGuide.global.type | |
| 32. ImplementationGuide.global.type.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.global.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. ImplementationGuide.global.type.extension:type | |
| Slice Name | type |
| Definition | DSTU2: |
| Short | DSTU2: Type this profiles applies to additional codes |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Type this profiles applies to additional codes) (Extension Type: code) |
| 36. ImplementationGuide.global.profile | |
| 38. ImplementationGuide.global.profile.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.global.profile.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. ImplementationGuide.global.profile.extension:profile | |
| Slice Name | profile |
| Definition | DSTU2: |
| Short | DSTU2: profile additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: profile additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition)) |
| 42. ImplementationGuide.definition | |
| 44. ImplementationGuide.definition.resource | |
| 46. ImplementationGuide.definition.resource.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.definition.resource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. ImplementationGuide.definition.resource.extension:purpose | |
| Slice Name | purpose |
| Definition | DSTU2: |
| Short | DSTU2: example | terminology | profile | extension | dictionary | logical (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: example | terminology | profile | extension | dictionary | logical (new)) (Extension Type: code) |
| 50. ImplementationGuide.definition.resource.extension:acronym | |
| Slice Name | acronym |
| Definition | DSTU2: |
| Short | DSTU2: Short code to identify the resource (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Short code to identify the resource (new)) (Extension Type: string) |
| 52. ImplementationGuide.definition.resource.extension:exampleFor | |
| Slice Name | exampleFor |
| Definition | DSTU2: |
| Short | DSTU2: Resource this is an example of (if applicable) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Resource this is an example of (if applicable) (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition)) |
| 54. ImplementationGuide.definition.resource.reference | |
| 56. ImplementationGuide.definition.resource.reference.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.definition.resource.reference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. ImplementationGuide.definition.resource.reference.extension:source | |
| Slice Name | source |
| Definition | DSTU2: |
| Short | DSTU2: source additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: source additional types) (Extension Type: uri) |
| 60. ImplementationGuide.definition.resource.reference.extension:sourceAlternateReference | |
| Slice Name | sourceAlternateReference |
| Definition | DSTU2: |
| Short | DSTU2: source additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| 62. ImplementationGuide.manifest | |
| 64. ImplementationGuide.manifest.page | |
| 66. ImplementationGuide.manifest.page.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.manifest.page.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. ImplementationGuide.manifest.page.extension:kind | |
| Slice Name | kind |
| Definition | DSTU2: |
| Short | DSTU2: page | example | list | include | directory | dictionary | toc | resource (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: page | example | list | include | directory | dictionary | toc | resource (new)) (Extension Type: code) |
| 70. ImplementationGuide.manifest.page.extension:type | |
| Slice Name | type |
| Definition | DSTU2: |
| Short | DSTU2: Kind of resource to include in the list (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Kind of resource to include in the list (new)) (Extension Type: code) |
| 72. ImplementationGuide.manifest.page.extension:package | |
| Slice Name | package |
| Definition | DSTU2: |
| Short | DSTU2: Name of package to include (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Name of package to include (new)) (Extension Type: string) |
| 74. ImplementationGuide.manifest.page.extension:format | |
| Slice Name | format |
| Definition | DSTU2: |
| Short | DSTU2: Format of the page (e.g. html, markdown, etc.) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Format of the page (e.g. html, markdown, etc.) (new)) (Extension Type: code) |
| 76. ImplementationGuide.manifest.page.extension:page | |
| Slice Name | page |
| Definition | DSTU2: |
| Short | DSTU2: Nested Pages / Sections (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Page/Section in the Guide) (Complex Extension) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImplementationGuide | |
| Definition | 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. |
| Short | A set of rules about how FHIR is used |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | cnl-0: 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}$'))ig-2: 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)) |
| 2. ImplementationGuide.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. ImplementationGuide.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. ImplementationGuide.meta.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 8. ImplementationGuide.meta.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. ImplementationGuide.meta.extension:meta | |
| Slice Name | meta |
| Definition | DSTU2: |
| Short | DSTU2: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: meta additional types) (Extension Type: Meta) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. ImplementationGuide.meta.versionId | |
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
| Short | Version specific identifier |
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. ImplementationGuide.meta.lastUpdated | |
| Definition | When the resource last changed - e.g. when the version changed. |
| Short | When the resource version last changed |
| Comments | This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
| Control | 0..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. ImplementationGuide.meta.source | |
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
| Short | Identifies where the resource comes from |
| Comments | The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. ImplementationGuide.meta.profile | |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | Profiles this resource claims to conform to |
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| Control | 0..* |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. ImplementationGuide.meta.security | |
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
| Short | Security Labels applied to this resource |
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from AllSecurityLabels ![]() (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)Security Labels from the Healthcare Privacy and Security Classification System. |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. ImplementationGuide.meta.tag | |
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
| Short | Tags applied to this resource |
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
| Control | 0..* |
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|5.0.0)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. ImplementationGuide.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. ImplementationGuide.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. ImplementationGuide.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. ImplementationGuide.text.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 32. ImplementationGuide.text.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. ImplementationGuide.text.extension:text | |
| Slice Name | text |
| Definition | DSTU2: |
| Short | DSTU2: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: text additional types) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 36. ImplementationGuide.text.status | |
| Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
| Short | generated | extensions | additional | empty |
| Control | 1..1 |
| Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|5.0.0)The status of a resource narrative. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. ImplementationGuide.text.div | |
| Definition | The actual narrative content, a stripped down version of XHTML. |
| Short | Limited xhtml content |
| Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
| Control | 1..1 |
| Type | xhtml |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes ( htmlChecks())txt-2: The narrative SHALL have some non-whitespace content ( htmlChecks()) |
| 40. ImplementationGuide.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 42. ImplementationGuide.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 44. ImplementationGuide.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 46. ImplementationGuide.url | |
| Definition | An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers. |
| Short | Canonical identifier for this implementation guide, represented as a URI (globally unique) |
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process. |
| Alternate Names | url, authoritative-url, destination, identity |
| Invariants | cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| 48. ImplementationGuide.identifier | |
| Definition | A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance. |
| Short | Additional identifier for the implementation guide (business identifier) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. ImplementationGuide.version | |
| Definition | The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
| Short | Business version of the implementation guide |
| Comments | There may be different implementation guide instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the implementation guide with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. ImplementationGuide.versionAlgorithm[x] | |
| Definition | Indicates the mechanism used to compare versions to determine which is more current. |
| Short | How to compare versions |
| Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithm (extensible to http://hl7.org/fhir/ValueSet/version-algorithm|5.0.0) |
| Type | Choice of: string, Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. ImplementationGuide.name | |
| Definition | A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Short | Name for this implementation guide (computer friendly) |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
| Control | 1..1 This element is affected by the following invariants: cnl-0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Support human navigation and code generation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. ImplementationGuide.title | |
| Definition | A short, descriptive, user-friendly title for the implementation guide. |
| Short | Name for this implementation guide (human friendly) |
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. ImplementationGuide.status | |
| Definition | The status of this implementation guide. Enables tracking the life-cycle of the content. |
| Short | draft | active | retired | unknown |
| Comments | Allows filtering of implementation guides that are appropriate for use versus not. See guidance around (not) making local changes to elements here. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)The lifecycle status of an artifact. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. ImplementationGuide.experimental | |
| Definition | A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
| Short | For testing purposes, not real usage |
| Comments | Allows filtering of implementation guides that are appropriate for use versus not. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide. |
| Meaning if Missing | If absent, this resource is treated as though it is not experimental. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. ImplementationGuide.date | |
| Definition | The date (and optionally time) when the implementation guide was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes. |
| Short | Date last changed |
| Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the implementation guide. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Alternate Names | Revision Date |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. ImplementationGuide.publisher | |
| Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide. |
| Short | Name of the publisher/steward (organization or individual) |
| Comments | Usually an organization but may be an individual. The publisher (or steward) of the implementation guide is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the implementation guide. This item SHOULD be populated unless the information is available from context. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Helps establish the "authority/credibility" of the implementation guide. May also allow for contact. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. ImplementationGuide.contact | |
| Definition | Contact details to assist a user in finding and communicating with the publisher. |
| Short | Contact details for the publisher |
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
| Control | 0..* |
| Type | ContactDetail |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. ImplementationGuide.contact.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 70. ImplementationGuide.contact.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. ImplementationGuide.contact.extension:name | |
| Slice Name | name |
| Definition | DSTU2: |
| Short | DSTU2: Name of a individual to contact (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Name of a individual to contact (new)) (Extension Type: string) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 74. ImplementationGuide.contact.extension:telecom | |
| Slice Name | telecom |
| Definition | DSTU2: |
| Short | DSTU2: Contact details for individual or publisher (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Contact details for individual or publisher (new)) (Extension Type: ContactPoint) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 76. ImplementationGuide.contact.name | |
| Definition | The name of an individual to contact. |
| Short | Name of an individual to contact |
| Comments | If there is no named individual, the telecom information is for the organization as a whole. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. ImplementationGuide.contact.telecom | |
| Definition | The contact details for the individual (if a name was provided) or the organization. |
| Short | Contact details for individual or organization |
| Control | 0..* |
| Type | ContactPoint |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. ImplementationGuide.description | |
| Definition | A free text natural language description of the implementation guide from a consumer's perspective. |
| Short | Natural language description of the implementation guide |
| Comments | This description can be used to capture details such as why the implementation guide was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the implementation guide as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the implementation guide is presumed to be the predominant language in the place the implementation guide was created). |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. ImplementationGuide.useContext | |
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances. |
| Short | The context that the content is intended to support |
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
| Control | 0..* |
| Type | UsageContext |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Assist in searching for appropriate content. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. ImplementationGuide.jurisdiction | |
| Definition | A legal or geographic region in which the implementation guide is intended to be used. |
| Short | Intended jurisdiction for implementation guide (if applicable) |
| Comments | It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0)Countries and regions within which this artifact is targeted for use. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. ImplementationGuide.purpose | |
| Definition | Explanation of why this implementation guide is needed and why it has been designed as it has. |
| Short | Why this implementation guide is defined |
| Comments | This element does not describe the usage of the implementation guide. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this implementation guide. |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. ImplementationGuide.copyright | |
| Definition | A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide. |
| Short | Use and/or publishing restrictions |
| Comments | ... |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content. |
| Alternate Names | License, Restrictions |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. ImplementationGuide.copyrightLabel | |
| Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). |
| Short | Copyright holder and year(s) |
| Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Defines the content expected to be rendered in all representations of the artifact. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. ImplementationGuide.packageId | |
| Definition | The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care. |
| Short | NPM Package name for IG |
| Comments | Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs. |
| Control | 1..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. ImplementationGuide.license | |
| Definition | The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'. |
| Short | SPDX license code for this IG (or not-open-source) |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SPDXLicense (required to http://hl7.org/fhir/ValueSet/spdx-license|5.0.0)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/). |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. ImplementationGuide.fhirVersion | |
| Definition | The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version. |
| Short | FHIR Version(s) this Implementation Guide targets |
| Comments | Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc. are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics. |
| Control | 1..* This element is affected by the following invariants: ig-2 |
| Binding | The codes SHALL be taken from FHIRVersion (required to http://hl7.org/fhir/ValueSet/FHIR-version|5.0.0)All published FHIR Versions. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 98. ImplementationGuide.dependsOn | |
| Definition | Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides. |
| Short | Another Implementation guide this depends on |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 100. ImplementationGuide.dependsOn.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 102. ImplementationGuide.dependsOn.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.dependsOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 104. ImplementationGuide.dependsOn.extension:type | |
| Slice Name | type |
| Definition | DSTU2: |
| Short | DSTU2: reference | inclusion (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: reference | inclusion (new)) (Extension Type: code) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 106. ImplementationGuide.dependsOn.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 108. ImplementationGuide.dependsOn.uri | |
| Definition | A canonical reference to the Implementation guide for the dependency. |
| Short | Identity of the IG that this depends on |
| Comments | Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published. |
| Control | 1..1 |
| Type | canonical(ImplementationGuide) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 110. ImplementationGuide.dependsOn.packageId | |
| Definition | The NPM package name for the Implementation Guide that this IG depends on. |
| Short | NPM Package name for IG this depends on |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 112. ImplementationGuide.dependsOn.version | |
| Definition | The version of the IG that is depended on, when the correct version is required to understand the IG correctly. |
| Short | Version of the IG |
| Comments | This follows the syntax of the NPM packaging version field - see [[reference]]. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 114. ImplementationGuide.dependsOn.reason | |
| Definition | A description explaining the nature of the dependency on the listed IG. |
| Short | Why dependency exists |
| Comments | This doesn't need to enumerate every resource used, but should give some sense of why the dependency exists. It will be used in the rendered list of dependencies |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 116. ImplementationGuide.global | |
| Definition | A set of profiles that all resources covered by this implementation guide must conform to. |
| Short | Profiles that apply globally |
| Comments | See Default Profiles for a discussion of which resources are 'covered' by an implementation guide. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 118. ImplementationGuide.global.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 120. ImplementationGuide.global.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 122. ImplementationGuide.global.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 124. ImplementationGuide.global.type | |
| Definition | The type of resource that all instances must conform to. |
| Short | Type this profile applies to |
| Comments | The type must match that of the profile that is referred to but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ResourceType ![]() (required to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)One of the resource types defined as part of this version of FHIR. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 126. ImplementationGuide.global.type.id | |
| Definition | unique id for the element within a resource (for internal references) |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 128. ImplementationGuide.global.type.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.global.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 130. ImplementationGuide.global.type.extension:type | |
| Slice Name | type |
| Definition | DSTU2: |
| Short | DSTU2: Type this profiles applies to additional codes |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Type this profiles applies to additional codes) (Extension Type: code) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 132. ImplementationGuide.global.type.value | |
| Definition | Primitive value for code |
| Short | Primitive value for code |
| Control | 0..1 |
| Type | code |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 134. ImplementationGuide.global.profile | |
| Definition | A reference to the profile that all instances must conform to. |
| Short | Profile that all resources must conform to |
| Control | 1..1 |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 136. ImplementationGuide.global.profile.id | |
| Definition | unique id for the element within a resource (for internal references) |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 138. ImplementationGuide.global.profile.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.global.profile.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 140. ImplementationGuide.global.profile.extension:profile | |
| Slice Name | profile |
| Definition | DSTU2: |
| Short | DSTU2: profile additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: profile additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 142. ImplementationGuide.global.profile.value | |
| Definition | Primitive value for canonical |
| Short | Primitive value for canonical |
| Control | 0..1 |
| Type | canonical |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 144. ImplementationGuide.definition | |
| Definition | The information needed by an IG publisher tool to publish the whole implementation guide. |
| Short | Information needed to build the IG |
| Comments | Principally, this consists of information abuot source resource and file locations, and build parameters and templates. |
| Control | 0..1 This element is affected by the following invariants: ig-2 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ig-1: 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)) |
| 146. ImplementationGuide.definition.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 148. ImplementationGuide.definition.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 150. ImplementationGuide.definition.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 152. ImplementationGuide.definition.grouping | |
| Definition | A logical group of resources. Logical groups can be used when building pages. |
| Short | Grouping used to present related resources in the IG |
| Comments | Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically. |
| Control | 0..* This element is affected by the following invariants: ig-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 154. ImplementationGuide.definition.grouping.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 156. ImplementationGuide.definition.grouping.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 158. ImplementationGuide.definition.grouping.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 160. ImplementationGuide.definition.grouping.name | |
| Definition | The human-readable title to display for the package of resources when rendering the implementation guide. |
| Short | Descriptive name for the package |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 162. ImplementationGuide.definition.grouping.description | |
| Definition | Human readable text describing the package. |
| Short | Human readable text describing the package |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 164. ImplementationGuide.definition.resource | |
| Definition | A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource. |
| Short | Resource in the implementation guide |
| Control | 0..* This element is affected by the following invariants: ig-2, ig-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 166. ImplementationGuide.definition.resource.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 168. ImplementationGuide.definition.resource.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.definition.resource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 170. ImplementationGuide.definition.resource.extension:purpose | |
| Slice Name | purpose |
| Definition | DSTU2: |
| Short | DSTU2: example | terminology | profile | extension | dictionary | logical (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: example | terminology | profile | extension | dictionary | logical (new)) (Extension Type: code) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 172. ImplementationGuide.definition.resource.extension:acronym | |
| Slice Name | acronym |
| Definition | DSTU2: |
| Short | DSTU2: Short code to identify the resource (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Short code to identify the resource (new)) (Extension Type: string) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 174. ImplementationGuide.definition.resource.extension:exampleFor | |
| Slice Name | exampleFor |
| Definition | DSTU2: |
| Short | DSTU2: Resource this is an example of (if applicable) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Resource this is an example of (if applicable) (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 176. ImplementationGuide.definition.resource.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 178. ImplementationGuide.definition.resource.reference | |
| Definition | Where this resource is found. |
| Short | Location of the resource |
| Comments | Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it. |
| Control | 1..1 |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 180. ImplementationGuide.definition.resource.reference.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 182. ImplementationGuide.definition.resource.reference.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.definition.resource.reference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 184. ImplementationGuide.definition.resource.reference.extension:source | |
| Slice Name | source |
| Definition | DSTU2: |
| Short | DSTU2: source additional types |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: source additional types) (Extension Type: uri) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 186. ImplementationGuide.definition.resource.reference.extension:sourceAlternateReference | |
| Slice Name | sourceAlternateReference |
| Definition | DSTU2: |
| Short | DSTU2: source additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(Alternate Reference) (Extension Type: Reference(Resource)) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 188. ImplementationGuide.definition.resource.reference.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 190. ImplementationGuide.definition.resource.reference.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType ![]() (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 192. ImplementationGuide.definition.resource.reference.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 194. ImplementationGuide.definition.resource.reference.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 196. ImplementationGuide.definition.resource.fhirVersion | |
| Definition | Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion. |
| Short | Versions this applies to (if different to IG) |
| Comments | The resource SHALL be valid against all the versions it is specified to apply to. If the resource referred to is a StructureDefinition, the fhirVersion stated in the StructureDefinition cannot disagree with the version specified here; the specified versions SHALL include the version specified by the StructureDefinition, and may include additional versions using the http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version extension. |
| Control | 0..* This element is affected by the following invariants: ig-2 |
| Binding | The codes SHALL be taken from FHIRVersion (required to http://hl7.org/fhir/ValueSet/FHIR-version|5.0.0)All published FHIR Versions. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 198. ImplementationGuide.definition.resource.name | |
| Definition | A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name). |
| Short | Human readable name for the resource |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 200. ImplementationGuide.definition.resource.description | |
| Definition | A description of the reason that a resource has been included in the implementation guide. |
| Short | Reason why included in guide |
| Comments | This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples). |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 202. ImplementationGuide.definition.resource.isExample | |
| Definition | If true, indicates the resource is an example instance. |
| Short | Is this an example |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 204. ImplementationGuide.definition.resource.profile | |
| Definition | If present, indicates profile(s) the instance is valid against. |
| Short | Profile(s) this is an example of |
| Comments | Examples:
|
| Control | 0..* |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 206. ImplementationGuide.definition.resource.groupingId | |
| Definition | Reference to the id of the grouping this resource appears in. |
| Short | Grouping this is part of |
| Comments | This must correspond to a group.id element within this implementation guide. |
| Control | 0..1 This element is affected by the following invariants: ig-1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 208. ImplementationGuide.definition.page | |
| Definition | A page / section in the implementation guide. The root page is the implementation guide home page. |
| Short | Page/Section in the Guide |
| Comments | Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html. |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ig-3: Source must be absent if 'generated' is generated ( generation='generated' implies source.empty()) |
| 210. ImplementationGuide.definition.page.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 212. ImplementationGuide.definition.page.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 214. ImplementationGuide.definition.page.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 216. ImplementationGuide.definition.page.source[x] | |
| Definition | Indicates the URL or the actual content to provide for the page. |
| Short | Source for page |
| Comments | If absent and the page isn't a generated page, this may be inferred from the page name by checking input locations. String is used for XHTML content - sent as an escaped string. FHIR tooling can't support 'direct' XHTML anywhere other than in narrative. |
| Control | 0..1 This element is affected by the following invariants: ig-3 |
| Type | Choice of: url, string, markdown |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 218. ImplementationGuide.definition.page.name | |
| Definition | The url by which the page should be known when published. |
| Short | Name of the page when published |
| Comments | This SHALL be a local reference, expressed with respect to the root of the IG output folder. No suffix is required. If no suffix is specified, .html will be appended. |
| Control | 1..1 |
| Type | url |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 220. ImplementationGuide.definition.page.title | |
| Definition | A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc. |
| Short | Short title shown for navigational assistance |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 222. ImplementationGuide.definition.page.generation | |
| Definition | A code that indicates how the page is generated. |
| Short | html | markdown | xml | generated |
| Control | 1..1 This element is affected by the following invariants: ig-3 |
| Binding | The codes SHALL be taken from GuidePageGeneration (required to http://hl7.org/fhir/ValueSet/guide-page-generation|5.0.0)A code that indicates how the page is generated. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 224. ImplementationGuide.definition.page.page | |
| Definition | Nested Pages/Sections under this page. |
| Short | Nested Pages / Sections |
| Comments | The implementation guide breadcrumbs may be generated from this structure. |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/ImplementationGuide#ImplementationGuide.definition.page |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 226. ImplementationGuide.definition.parameter | |
| Definition | A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides. |
| Short | Defines how IG is built by tools |
| Comments | see confluence for the parameters defined by the HL7 IG publisher. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 228. ImplementationGuide.definition.parameter.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 230. ImplementationGuide.definition.parameter.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 232. ImplementationGuide.definition.parameter.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 234. ImplementationGuide.definition.parameter.code | |
| Definition | A tool-specific code that defines the parameter. |
| Short | Code that identifies parameter |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from GuideParameterCode (extensible to http://hl7.org/fhir/ValueSet/guide-parameter-code|5.0.0) |
| Type | Coding |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 236. ImplementationGuide.definition.parameter.value | |
| Definition | Value for named type. |
| Short | Value for named type |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 238. ImplementationGuide.definition.template | |
| Definition | A template for building resources. |
| Short | A template for building resources |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 240. ImplementationGuide.definition.template.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 242. ImplementationGuide.definition.template.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 244. ImplementationGuide.definition.template.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 246. ImplementationGuide.definition.template.code | |
| Definition | Type of template specified. |
| Short | Type of template specified |
| Control | 1..1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 248. ImplementationGuide.definition.template.source | |
| Definition | The source location for the template. |
| Short | The source location for the template |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 250. ImplementationGuide.definition.template.scope | |
| Definition | The scope in which the template applies. |
| Short | The scope in which the template applies |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 252. ImplementationGuide.manifest | |
| Definition | Information about an assembled implementation guide, created by the publication tooling. |
| Short | Information about an assembled IG |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 254. ImplementationGuide.manifest.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 256. ImplementationGuide.manifest.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 258. ImplementationGuide.manifest.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 260. ImplementationGuide.manifest.rendering | |
| Definition | A pointer to official web page, PDF or other rendering of the implementation guide. |
| Short | Location of rendered implementation guide |
| Control | 0..1 |
| Type | url |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 262. ImplementationGuide.manifest.resource | |
| Definition | A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource. |
| Short | Resource in the implementation guide |
| Control | 1..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 264. ImplementationGuide.manifest.resource.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 266. ImplementationGuide.manifest.resource.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 268. ImplementationGuide.manifest.resource.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 270. ImplementationGuide.manifest.resource.reference | |
| Definition | Where this resource is found. |
| Short | Location of the resource |
| Comments | Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it. |
| Control | 1..1 |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 272. ImplementationGuide.manifest.resource.isExample | |
| Definition | If true, indicates the resource is an example instance. |
| Short | Is this an example |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 274. ImplementationGuide.manifest.resource.profile | |
| Definition | If present, indicates profile(s) the instance is valid against. |
| Short | Profile(s) this is an example of |
| Comments | Examples:
|
| Control | 0..* |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 276. ImplementationGuide.manifest.resource.relativePath | |
| Definition | The relative path for primary page for this resource within the IG. |
| Short | Relative path for page in IG |
| Comments | Appending 'rendering' + "/" + this should resolve to the resource page. |
| Control | 0..1 |
| Type | url |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 278. ImplementationGuide.manifest.page | |
| Definition | Information about a page within the IG. |
| Short | HTML page within the parent IG |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 280. ImplementationGuide.manifest.page.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 282. ImplementationGuide.manifest.page.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ImplementationGuide.manifest.page.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 284. ImplementationGuide.manifest.page.extension:kind | |
| Slice Name | kind |
| Definition | DSTU2: |
| Short | DSTU2: page | example | list | include | directory | dictionary | toc | resource (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: page | example | list | include | directory | dictionary | toc | resource (new)) (Extension Type: code) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 286. ImplementationGuide.manifest.page.extension:type | |
| Slice Name | type |
| Definition | DSTU2: |
| Short | DSTU2: Kind of resource to include in the list (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Kind of resource to include in the list (new)) (Extension Type: code) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 288. ImplementationGuide.manifest.page.extension:package | |
| Slice Name | package |
| Definition | DSTU2: |
| Short | DSTU2: Name of package to include (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Name of package to include (new)) (Extension Type: string) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 290. ImplementationGuide.manifest.page.extension:format | |
| Slice Name | format |
| Definition | DSTU2: |
| Short | DSTU2: Format of the page (e.g. html, markdown, etc.) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Format of the page (e.g. html, markdown, etc.) (new)) (Extension Type: code) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 292. ImplementationGuide.manifest.page.extension:page | |
| Slice Name | page |
| Definition | DSTU2: |
| Short | DSTU2: Nested Pages / Sections (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Page/Section in the Guide) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 294. ImplementationGuide.manifest.page.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 296. ImplementationGuide.manifest.page.name | |
| Definition | Relative path to the page. |
| Short | HTML page name |
| Comments | Appending 'rendering' + "/" + this should resolve to the page. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 298. ImplementationGuide.manifest.page.title | |
| Definition | Label for the page intended for human display. |
| Short | Title of the page, for references |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Allows generation of labels for markdown-generated hyperlinks. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 300. ImplementationGuide.manifest.page.anchor | |
| Definition | The name of an anchor available on the page. |
| Short | Anchor available on the page |
| Comments | Appending 'rendering' + "/" + page.name + "#" + page.anchor should resolve to the anchor. |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 302. ImplementationGuide.manifest.image | |
| Definition | Indicates a relative path to an image that exists within the IG. |
| Short | Image within the IG |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Allows validation of image links from a derived IG to this IG without a local copy of the IG. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 304. ImplementationGuide.manifest.other | |
| Definition | Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG. |
| Short | Additional linkable file in IG |
| Control | 0..* |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Allows validation of links from a derived IG to this IG without a local copy of the IG. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |