Generated Narrative: StructureDefinition profile-ImplementationGuide Name Flags Card. Type Description & Constraints ImplementationGuide 1..1 ImplementationGuide A set of rules about how FHIR is used #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:title 0..1 string R4: Name for this implementation guide (human friendly) (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.title #xD; extension:packageId 1..1 id R4: NPM Package name for IG (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.packageId #xD; extension:license 0..1 code R4: SPDX license code for this IG (or not-open-source) (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.license Binding: R4SpdxLicenseForR3 (0.1.0) (required): The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/). #xD; extension:definition 0..1 (Complex) R4: Information needed to build the IG (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition #xD; extension:page 0..1 (Complex) R4: Page/Section in the Guide (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.page #xD; extension:page 0..* (Complex) R4: Nested Pages / Sections (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.definition.page #xD; extension:manifest 0..1 (Complex) R4: Information about an assembled IG (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.manifest #xD; fhirVersion #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:fhirVersion 1..* code R4: FHIR Version(s) this Implementation Guide targets additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.fhirVersion Binding: R4FHIRVersionForR3 (0.1.0) (required): All published FHIR Versions. #xD; global #xD; type #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 0..1 code R4: Type this profile applies to URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.global.type Binding: R4ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR. #xD; profile #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:profile 0..1 uri R4: profile additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ImplementationGuide.global.profile #xD; Documentation for this format
Cross-version Profile for R4.ImplementationGuide for use in FHIR STU3
This cross-version profile allows R4 ImplementationGuide content to be represented via FHIR STU3 ImplementationGuide resources.
A set of rules of how FHIR is used to solve a particular problem. 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.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL NOT contain any narrative
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource, and may 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.
Contained resources do not have 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 in formation is added later.
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.
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.
R4: Name for this implementation guide (human friendly) (new)
R4: `ImplementationGuide.title` (new:string)
Element `ImplementationGuide.title` has a context of ImplementationGuide based on following the parent source element upwards and mapping to `ImplementationGuide`. Element `ImplementationGuide.title` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
R4: `ImplementationGuide.packageId` (new:id)
Element `ImplementationGuide.packageId` has a context of ImplementationGuide based on following the parent source element upwards and mapping to `ImplementationGuide`. Element `ImplementationGuide.packageId` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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.
R4: SPDX license code for this IG (or not-open-source) (new)
R4: `ImplementationGuide.license` (new:code)
Element `ImplementationGuide.license` has a context of ImplementationGuide based on following the parent source element upwards and mapping to `ImplementationGuide`. Element `ImplementationGuide.license` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R4: Information needed to build the IG (new)
R4: `ImplementationGuide.definition` (new:BackboneElement)
Element `ImplementationGuide.definition` has a context of ImplementationGuide based on following the parent source element upwards and mapping to `ImplementationGuide`. Element `ImplementationGuide.definition` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Principally, this consists of information abuot source resource and file locations, and build parameters and templates.
R4: `ImplementationGuide.definition.page` (new:BackboneElement)
Element `ImplementationGuide.definition.page` is part of an existing definition because parent element `ImplementationGuide.definition` requires a cross-version extension. Element `ImplementationGuide.definition.page` has a context of ImplementationGuide based on following the parent source element upwards and mapping to `ImplementationGuide`. Element `ImplementationGuide.definition.page` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.
R4: `ImplementationGuide.definition.page.page` (new:ImplementationGuide.definition.page)
Element `ImplementationGuide.definition.page.page` is part of an existing definition because parent element `ImplementationGuide.definition.page` requires a cross-version extension. Element `ImplementationGuide.definition.page.page` has a context of ImplementationGuide based on following the parent source element upwards and mapping to `ImplementationGuide`. Element `ImplementationGuide.definition.page.page` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The implementation guide breadcrumbs are generated from this structure.
R4: Information about an assembled IG (new)
R4: `ImplementationGuide.manifest` (new:BackboneElement)
Element `ImplementationGuide.manifest` has a context of ImplementationGuide based on following the parent source element upwards and mapping to `ImplementationGuide`. Element `ImplementationGuide.manifest` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
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. Usually modifier elements provide negation or qualification. In order 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.
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.
Logical URI to reference this implementation guide (globally unique)
An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](http://hl7.org/fhir/STU3/resource.html#versions).
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.
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.
Business version of the implementation guide
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.
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 refrence to a particular business version of the implementation guide with the format [url]|[version].
Name for this implementation guide (computer friendly)
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.
The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.
Support human navigation and code generation.
The status of this implementation guide. Enables tracking the life-cycle of the content.
Allows filtering of implementation guides that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired implementation guide without due consideration.
The lifecycle status of a Value Set or Concept Map.
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.
Allows filtering of implementation guide that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental implementation guide in production.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.
The date (and optionally time) when the implementation guide was published. The date must change if and 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.
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.
Name of the publisher (organization or individual)
The name of the individual or organization that published the implementation guide.
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.
Helps establish the "authority/credibility" of the implementation guide. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
Natural language description of the implementation guide
A free text natural language description of the implementation guide from a consumer's perspective.
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 profile is presumed to be the predominant language in the place the profile was created).
Context the content is intended to support
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide instances.
When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for implementation guide (if applicable)
A legal or geographic region in which the implementation guide is intended to be used.
It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use
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.
Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.
FHIR Version this Implementation Guide targets
The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.2 for this version.
An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR.
unique id for the element within a resource (for internal references)
R4: FHIR Version(s) this Implementation Guide targets additional types
R4: `ImplementationGuide.fhirVersion` additional types (code) additional types from child elements (value)
Element `ImplementationGuide.fhirVersion` is mapped to FHIR STU3 element `ImplementationGuide.fhirVersion` as `SourceIsBroaderThanTarget`. The mappings for `ImplementationGuide.fhirVersion` do not cover the following types: code. The mappings for `ImplementationGuide.fhirVersion` do not cover the following types based on type expansion: value. 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.
Another Implementation guide this depends on
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional Content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
How the dependency is represented when the guide is published.
For information about processing included guides, see [Including Guides]{implementationguide.html#include}.
How a dependency is represented when the guide is published.
When a guide is published, and the type is 'include', this will be a relative reference within the guide.
Group of resources as used in .page.package
A logical group of resources. Logical groups can be used when building pages.
The name for the group, as used in page.package.
Human readable text describing the package
Human readable text describing the package.
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.
If not an example, has its normal meaning
Whether a resource is included in the guide as part of the rules defined by the guide, or just as an example of a resource that conforms to the rules and/or help implementers understand the intent of the guide.
Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.
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).
A description of the reason that a resource has been included in the implementation guide.
This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).
A short code that may be used to identify the resource throughout the implementation guide.
This is used when generating schematrons from profiles, for example, but has other uses. Publishing tooling may autogenerate this value, but a human assigned value is more useful. This value must be unique within an implementation guide (across included guides as well).
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.
Resource this is an example of (if applicable)
Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.
Examples: * StructureDefinition -> Any * ValueSet -> expansion * OperationDefinition -> Parameters * Questionnaire -> QuestionnaireResponse.
A set of profiles that all resources covered by this implementation guide must conform to.
See [Default Profiles](http://hl7.org/fhir/STU3/implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.
The type of resource that all instances must conform to.
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.
One of the resource types defined as part of FHIR.
Element `ImplementationGuide.global.type` is mapped to FHIR STU3 element `ImplementationGuide.global.type` as `SourceIsBroaderThanTarget`. 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.
Profile that all resources must conform to
A reference to the profile that all instances must conform to.
Extensions are always sliced by (at least) url
R4: `ImplementationGuide.global.profile` additional types (canonical(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (value)
Element `ImplementationGuide.global.profile` is mapped to FHIR STU3 element `ImplementationGuide.global.profile` as `SourceIsBroaderThanTarget`. The mappings for `ImplementationGuide.global.profile` do not cover the following types: canonical. The mappings for `ImplementationGuide.global.profile` do not cover the following types based on type expansion: value.
Literal reference, Relative, internal or absolute URL
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.
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.
Logical reference, when literal reference is not known
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.
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.
Plain text narrative that identifies the resource in addition to the resource reference.
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.
A binary file that is included in the implementation guide when it is published.
This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide.
A page / section in the implementation guide. The root page is the implementation guide home page.
Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.
The publishing tool will autogenerate source for list (source = n/a), and inject included implementations for include (source = uri of guide to include).
Short title shown for navigational assistance
A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
page | example | list | include | directory | dictionary | toc | resource
The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest.
For constructed pages, what kind of resources to include in the list.
For constructed pages, a list of packages to include in the page (or else empty for everything).
Format of the page (e.g. html, markdown, etc.)
This is primarily for the publishing tool, that will convert all pages to html format. HTML pages are pre-processed, see xxxx.
The mime type of an attachment. Any valid mime type is allowed.
The implementation guide breadcrumbs are generated from this structure.