ImplementationGuide | 0..* | ImplementationGuide | 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. |
ImplementationGuide.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
ImplementationGuide.meta | 0..1 | Meta | 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. |
ImplementationGuide.implicitRules | 0..1 | uri | 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. |
ImplementationGuide.language | 0..1 | code | The base language in which the resource is written. |
ImplementationGuide.text | 0..1 | Narrative | 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. |
ImplementationGuide.contained | 0..* | Resource | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
ImplementationGuide.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.url | 1..1 | uri | 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 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. |
ImplementationGuide.version | 0..1 | string | 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. |
ImplementationGuide.name | 1..1 | string | 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. |
ImplementationGuide.title | 0..1 | string | A short, descriptive, user-friendly title for the implementation guide. |
ImplementationGuide.status | 1..1 | code | The status of this implementation guide. Enables tracking the life-cycle of the content. |
ImplementationGuide.experimental | 0..1 | boolean | 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. |
ImplementationGuide.date | 0..1 | dateTime | The date (and optionally time) when the implementation guide was published. 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. |
ImplementationGuide.publisher | 0..1 | string | The name of the organization or individual that published the implementation guide. |
ImplementationGuide.contact | 0..* | ContactDetail | Contact details to assist a user in finding and communicating with the publisher. |
ImplementationGuide.description | 0..1 | markdown | A free text natural language description of the implementation guide from a consumer's perspective. |
ImplementationGuide.useContext | 0..* | UsageContext | 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. |
ImplementationGuide.jurisdiction | 0..* | CodeableConcept | A legal or geographic region in which the implementation guide is intended to be used. |
ImplementationGuide.copyright | 0..1 | markdown | 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. |
ImplementationGuide.packageId | 1..1 | id | 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. |
ImplementationGuide.license | 0..1 | code | The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'. |
ImplementationGuide.fhirVersion | 1..* | code | 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.0.1. for this version. |
ImplementationGuide.dependsOn | 0..* | BackboneElement | Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides. |
ImplementationGuide.dependsOn.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.dependsOn.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.dependsOn.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.dependsOn.uri | 1..1 | canonical | A canonical reference to the Implementation guide for the dependency. |
ImplementationGuide.dependsOn.packageId | 0..1 | id | The NPM package name for the Implementation Guide that this IG depends on. |
ImplementationGuide.dependsOn.version | 0..1 | string | The version of the IG that is depended on, when the correct version is required to understand the IG correctly. |
ImplementationGuide.global | 0..* | BackboneElement | A set of profiles that all resources covered by this implementation guide must conform to. |
ImplementationGuide.global.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.global.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.global.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.global.type | 1..1 | code | The type of resource that all instances must conform to. |
ImplementationGuide.global.profile | 1..1 | canonical | A reference to the profile that all instances must conform to. |
ImplementationGuide.definition | 0..1 | BackboneElement | The information needed by an IG publisher tool to publish the whole implementation guide. |
ImplementationGuide.definition.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.definition.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.definition.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.definition.grouping | 0..* | BackboneElement | A logical group of resources. Logical groups can be used when building pages. |
ImplementationGuide.definition.grouping.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.definition.grouping.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.definition.grouping.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.definition.grouping.name | 1..1 | string | The human-readable title to display for the package of resources when rendering the implementation guide. |
ImplementationGuide.definition.grouping.description | 0..1 | string | Human readable text describing the package. |
ImplementationGuide.definition.resource | 1..* | BackboneElement | 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. |
ImplementationGuide.definition.resource.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.definition.resource.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.definition.resource.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.definition.resource.reference | 1..1 | Reference | Where this resource is found. |
ImplementationGuide.definition.resource.fhirVersion | 0..* | code | 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. |
ImplementationGuide.definition.resource.name | 0..1 | string | 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). |
ImplementationGuide.definition.resource.description | 0..1 | string | A description of the reason that a resource has been included in the implementation guide. |
ImplementationGuide.definition.resource.example[x] | 0..1 | boolean | If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile. |
ImplementationGuide.definition.resource.groupingId | 0..1 | id | Reference to the id of the grouping this resource appears in. |
ImplementationGuide.definition.page | 0..1 | BackboneElement | A page / section in the implementation guide. The root page is the implementation guide home page. |
ImplementationGuide.definition.page.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.definition.page.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.definition.page.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.definition.page.name[x] | 1..1 | url | The source address for the page. |
ImplementationGuide.definition.page.title | 1..1 | string | A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc. |
ImplementationGuide.definition.page.generation | 1..1 | code | A code that indicates how the page is generated. |
ImplementationGuide.definition.page.page | 0..* | ImplementationGuide | Nested Pages/Sections under this page. |
ImplementationGuide.definition.parameter | 0..* | BackboneElement | Defines how IG is built by tools. |
ImplementationGuide.definition.parameter.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.definition.parameter.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.definition.parameter.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.definition.parameter.code | 1..1 | code | apply / path-resource / path-pages / path-tx-cache / expansion-parameter / rule-broken-links / generate-xml / generate-json / generate-turtle / html-template. |
ImplementationGuide.definition.parameter.value | 1..1 | string | Value for named type. |
ImplementationGuide.definition.template | 0..* | BackboneElement | A template for building resources. |
ImplementationGuide.definition.template.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.definition.template.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.definition.template.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.definition.template.code | 1..1 | code | Type of template specified. |
ImplementationGuide.definition.template.source | 1..1 | string | The source location for the template. |
ImplementationGuide.definition.template.scope | 0..1 | string | The scope in which the template applies. |
ImplementationGuide.manifest | 0..1 | BackboneElement | Information about an assembled implementation guide, created by the publication tooling. |
ImplementationGuide.manifest.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.manifest.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.manifest.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.manifest.rendering | 0..1 | url | A pointer to official web page, PDF or other rendering of the implementation guide. |
ImplementationGuide.manifest.resource | 1..* | BackboneElement | 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. |
ImplementationGuide.manifest.resource.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.manifest.resource.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.manifest.resource.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.manifest.resource.reference | 1..1 | Reference | Where this resource is found. |
ImplementationGuide.manifest.resource.example[x] | 0..1 | boolean | If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile. |
ImplementationGuide.manifest.resource.relativePath | 0..1 | url | The relative path for primary page for this resource within the IG. |
ImplementationGuide.manifest.page | 0..* | BackboneElement | Information about a page within the IG. |
ImplementationGuide.manifest.page.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
ImplementationGuide.manifest.page.extension | 0..* | Extension | 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 manageable, 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. |
ImplementationGuide.manifest.page.modifierExtension | 0..* | Extension | 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 manageable, 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). |
ImplementationGuide.manifest.page.name | 1..1 | string | Relative path to the page. |
ImplementationGuide.manifest.page.title | 0..1 | string | Label for the page intended for human display. |
ImplementationGuide.manifest.page.anchor | 0..* | string | The name of an anchor available on the page. |
ImplementationGuide.manifest.image | 0..* | string | Indicates a relative path to an image that exists within the IG. |
ImplementationGuide.manifest.other | 0..* | string | 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. |