Complex
Primitive
ActivityDefinition
CapabilityStatement
CodeSystem
Composition
ConceptMap
Encounter
Library
List
Measure
MessageHeader
Observation
Patient
PlanDefinition
Questionnaire
Resource
ServiceDefinition
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for ImplementationGuide Resource
ImplementationGuide
Path
ImplementationGuide
Id
ImplementationGuide
Cardinality
1 - 1
Definition
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.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1 [error]
If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
Path
ImplementationGuide.url
Id
ImplementationGuide.url
Type
Cardinality
1 - 1
Definition
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](resource.html#versions).
Comment
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.
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.
Path
ImplementationGuide.version
Id
ImplementationGuide.version
Type
Cardinality
0 - 1
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.
Comment
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].
Path
ImplementationGuide.name
Id
ImplementationGuide.name
Type
Cardinality
1 - 1
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.
Comment
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.
Requirements
Support human navigation and code generation.
Path
ImplementationGuide.status
Id
ImplementationGuide.status
Type
Cardinality
1 - 1
Definition
The status of this implementation guide. Enables tracking the life-cycle of the content.
Comment
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.
Path
ImplementationGuide.experimental
Id
ImplementationGuide.experimental
Type
Cardinality
0 - 1
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.
Comment
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.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.
Path
ImplementationGuide.date
Id
ImplementationGuide.date
Type
Cardinality
0 - 1
Definition
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.
Comment
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.
Path
ImplementationGuide.publisher
Id
ImplementationGuide.publisher
Type
Cardinality
0 - 1
Definition
The name of the individual or organization that published the implementation guide.
Comment
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.
Requirements
Helps establish the "authority/credibility" of the implementation guide. May also allow for contact.
Path
ImplementationGuide.contact
Id
ImplementationGuide.contact
Type
Cardinality
0 - *
Definition
Contact details to assist a user in finding and communicating with the publisher.
Comment
May be a web site, an email address, a telephone number, etc.
Path
ImplementationGuide.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Path
ImplementationGuide.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Path
ImplementationGuide.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Condition
cpt-2
Path
ImplementationGuide.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Path
ImplementationGuide.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Path
ImplementationGuide.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Path
ImplementationGuide.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Path
ImplementationGuide.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Condition
per-1
Path
ImplementationGuide.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
ImplementationGuide.description
Id
ImplementationGuide.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the implementation guide from a consumer's perspective.
Comment
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).
Path
ImplementationGuide.useContext
Id
ImplementationGuide.useContext
Type
Cardinality
0 - *
Definition
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.
Comment
When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Path
ImplementationGuide.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Path
ImplementationGuide.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
ImplementationGuide.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
ImplementationGuide.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
ImplementationGuide.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
ImplementationGuide.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
ImplementationGuide.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Path
ImplementationGuide.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
ImplementationGuide.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
ImplementationGuide.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
ImplementationGuide.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
ImplementationGuide.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
ImplementationGuide.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
ImplementationGuide.jurisdiction
Id
ImplementationGuide.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the implementation guide is intended to be used.
Comment
It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.
Path
ImplementationGuide.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
ImplementationGuide.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
ImplementationGuide.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
ImplementationGuide.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
ImplementationGuide.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
ImplementationGuide.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
ImplementationGuide.copyright
Id
ImplementationGuide.copyright
Type
Cardinality
0 - 1
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.
Comment
Requirements
Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.
Path
ImplementationGuide.fhirVersion
Id
ImplementationGuide.fhirVersion
Type
Cardinality
0 - 1
Definition
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.
Comment
An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR.
Path
ImplementationGuide.dependency
Id
ImplementationGuide.dependency
Type
Cardinality
0 - *
Definition
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ImplementationGuide.dependency.type
Id
ImplementationGuide.dependency.type
Type
Cardinality
1 - 1
Definition
How the dependency is represented when the guide is published.
Comment
For information about processing included guides, see [Including Guides]{implementationguide.html#include}.
Path
ImplementationGuide.dependency.uri
Id
ImplementationGuide.dependency.uri
Type
Cardinality
1 - 1
Definition
Where the dependency is located.
Comment
When a guide is published, and the type is 'include', this will be a relative reference within the guide.
Path
ImplementationGuide.package
Id
ImplementationGuide.package
Type
Cardinality
0 - *
Definition
A logical group of resources. Logical groups can be used when building pages.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ImplementationGuide.package.name
Id
ImplementationGuide.package.name
Type
Cardinality
1 - 1
Definition
The name for the group, as used in page.package.
Comment
Path
ImplementationGuide.package.description
Id
ImplementationGuide.package.description
Type
Cardinality
0 - 1
Definition
Human readable text describing the package.
Comment
Path
ImplementationGuide.package.resource
Id
ImplementationGuide.package.resource
Type
Cardinality
1 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ImplementationGuide.package.resource.example
Id
ImplementationGuide.package.resource.example
Type
Cardinality
1 - 1
Definition
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.
Comment
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.
Path
ImplementationGuide.package.resource.name
Id
ImplementationGuide.package.resource.name
Type
Cardinality
0 - 1
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).
Comment
Path
ImplementationGuide.package.resource.description
Id
ImplementationGuide.package.resource.description
Type
Cardinality
0 - 1
Definition
A description of the reason that a resource has been included in the implementation guide.
Comment
This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).
Path
ImplementationGuide.package.resource.acronym
Id
ImplementationGuide.package.resource.acronym
Type
Cardinality
0 - 1
Definition
A short code that may be used to identify the resource throughout the implementation guide.
Comment
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).
Path
ImplementationGuide.package.resource.source[x]
Id
ImplementationGuide.package.resource.source[x]
Type
Cardinality
1 - 1
Definition
Where this resource is found.
Comment
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.
Path
ImplementationGuide.package.resource.exampleFor
Id
ImplementationGuide.package.resource.exampleFor
Type
Cardinality
0 - 1
Definition
Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.
Comment
Examples:
* StructureDefinition -> Any
* ValueSet -> expansion
* OperationDefinition -> Parameters
* Questionnaire -> QuestionnaireResponse.
Path
ImplementationGuide.package.resource.exampleFor.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Condition
ref-1
Path
ImplementationGuide.package.resource.exampleFor.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
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.
Comment
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.
Path
ImplementationGuide.package.resource.exampleFor.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Path
ImplementationGuide.global
Id
ImplementationGuide.global
Type
Cardinality
0 - *
Definition
A set of profiles that all resources covered by this implementation guide must conform to.
Comment
See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ImplementationGuide.global.type
Id
ImplementationGuide.global.type
Type
Cardinality
1 - 1
Definition
The type of resource that all instances must conform to.
Comment
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.
Path
ImplementationGuide.global.profile
Id
ImplementationGuide.global.profile
Type
Cardinality
1 - 1
Definition
A reference to the profile that all instances must conform to.
Comment
Path
ImplementationGuide.global.profile.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
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.
Comment
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.
Condition
ref-1
Path
ImplementationGuide.global.profile.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
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.
Comment
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.
Path
ImplementationGuide.global.profile.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
ImplementationGuide.global.profile.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
ImplementationGuide.global.profile.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
ImplementationGuide.global.profile.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
ImplementationGuide.global.profile.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
ImplementationGuide.global.profile.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
ImplementationGuide.global.profile.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
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.
Path
ImplementationGuide.binary
Id
ImplementationGuide.binary
Type
Cardinality
0 - *
Definition
A binary file that is included in the implementation guide when it is published.
Comment
This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide.
Path
ImplementationGuide.page
Id
ImplementationGuide.page
Type
Cardinality
0 - 1
Definition
A page / section in the implementation guide. The root page is the implementation guide home page.
Comment
Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ImplementationGuide.page.source
Id
ImplementationGuide.page.source
Type
Cardinality
1 - 1
Definition
The source address for the page.
Comment
The publishing tool will autogenerate source for list (source = n/a), and inject included implementations for include (source = uri of guide to include).
Path
ImplementationGuide.page.title
Id
ImplementationGuide.page.title
Type
Cardinality
1 - 1
Definition
A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
Comment
Path
ImplementationGuide.page.kind
Id
ImplementationGuide.page.kind
Type
Cardinality
1 - 1
Definition
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.
Comment
Path
ImplementationGuide.page.type
Id
ImplementationGuide.page.type
Type
Cardinality
0 - *
Definition
For constructed pages, what kind of resources to include in the list.
Comment
Path
ImplementationGuide.page.package
Id
ImplementationGuide.page.package
Type
Cardinality
0 - *
Definition
For constructed pages, a list of packages to include in the page (or else empty for everything).
Comment
Path
ImplementationGuide.page.format
Id
ImplementationGuide.page.format
Type
Cardinality
0 - 1
Definition
The format of the page.
Comment
This is primarily for the publishing tool, that will convert all pages to html format. HTML pages are pre-processed, see xxxx.
Path
ImplementationGuide.page.page
Id
ImplementationGuide.page.page
Type
Cardinality
0 - *
Definition
Nested Pages/Sections under this page.
Comment
The implementation guide breadcrumbs are generated from this structure.