Summary
Request & Response
Diagnostics
Care Provision
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Terminology
Documents
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CanonicalResource
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
DocumentReference
Encounter
EpisodeOfCare
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
SpecimenDefinition
StructureDefinition
StructureMap
Subscription
ValueSet
default
A walkthrough of a workflow showing the interaction between systems and the instances shared, possibly including the evolution of instances over time.
ExampleScenario
Path
ExampleScenario
Id
ExampleScenario
Cardinality
0 - *
Definition
Example of workflow instance.
Comment
Constraint
cnl-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
exs-3 [error]
Must have actors if status is active or required
exs-4 [error]
Must have processes if status is active or required
exs-6 [error]
Actor keys must be unique
exs-7 [error]
Actor titles must be unique
exs-8 [error]
Instance keys must be unique
exs-9 [error]
Instance titles must be unique
exs-12 [error]
Process titles must be unique
Path
ExampleScenario.url
Id
ExampleScenario.url
Type
Cardinality
0 - 1
Definition
An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.
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.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
Requirements
Allows the example scenario to be referenced by a single globally unique identifier.
Constraint
cnl-1 [warning]
URL should not contain | or # - these characters make processing canonical references problematic
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier
Id
ExampleScenario.identifier
Type
Cardinality
0 - *
Definition
A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.
Comment
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this example scenario outside of FHIR, where it is not possible to use the logical URI.
Requirements
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
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.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.type.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 alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.type.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.type.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.type.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.identifier.Identifier.type.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExampleScenario.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExampleScenario.identifier.Identifier.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 no end was known or planned at the time the instance was created. 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 end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.assigner.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExampleScenario.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExampleScenario.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
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.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.assigner.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.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.assigner.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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExampleScenario.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.assigner.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.identifier.Identifier.assigner.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExampleScenario.version
Id
ExampleScenario.version
Type
Cardinality
0 - 1
Definition
The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario 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 example scenario instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the example scenario with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.versionAlgorithm[x]
Id
ExampleScenario.versionAlgorithm[x]
Type
Cardinality
0 - 1
Definition
Indicates the mechanism used to compare versions to determine which is more current.
Comment
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.name
Id
ExampleScenario.name
Type
Cardinality
0 - 1
Definition
Temporarily retained for tooling purposes.
Comment
Not needed as code will never be generated from one of these
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cnl-0
Path
ExampleScenario.title
Id
ExampleScenario.title
Type
Cardinality
0 - 1
Definition
A short, descriptive, user-friendly title for the ExampleScenario.
Comment
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.status
Id
ExampleScenario.status
Type
Cardinality
1 - 1
Definition
The status of this example scenario. Enables tracking the life-cycle of the content.
Comment
Allows filtering of example scenarios that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Binding
Strength
required
Description
The lifecycle status of an artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-3
exs-4
exs-5
Path
ExampleScenario.experimental
Id
ExampleScenario.experimental
Type
Cardinality
0 - 1
Definition
A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Comment
Allows filtering of example scenarios that are appropriate for use versus not.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.date
Id
ExampleScenario.date
Type
Cardinality
0 - 1
Definition
The date (and optionally time) when the example scenario was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').
Comment
The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the example scenario. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.publisher
Id
ExampleScenario.publisher
Type
Cardinality
0 - 1
Definition
The name of the organization or individual responsible for the release and ongoing maintenance of the example scenario.
Comment
Usually an organization but may be an individual. The publisher (or steward) of the example scenario is the organization or individual primarily responsible for the maintenance and upkeep of the example scenario. 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 example scenario. This item SHOULD be populated unless the information is available from context.
Requirements
Helps establish the "authority/credibility" of the example scenario. May also allow for contact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.contact
Id
ExampleScenario.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.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
ExampleScenario.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
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.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExampleScenario.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 no end was known or planned at the time the instance was created. 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 end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
ExampleScenario.description
Id
ExampleScenario.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the ExampleScenario from a consumer's perspective.
Comment
This description can be used to capture details such as comments about misuse. It is not a rendering of the ExampleScenario as conveyed in the 'text' field of the resource itself.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.useContext
Id
ExampleScenario.useContext
Type
Cardinality
0 - *
Definition
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances.
Comment
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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
Binding
Strength
extensible
Description
A code that specifies a type of context being specified by a usage context.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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
Binding
Strength
example
Description
A code that defines the specific value for the context being specified.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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 alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.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 - e.g. 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.jurisdiction
Id
ExampleScenario.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the example scenario is intended to be used.
Comment
It may be possible for the example scenario to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Binding
Strength
extensible
Description
Countries and regions within which this artifact is targeted for use.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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 alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.purpose
Id
ExampleScenario.purpose
Type
Cardinality
0 - 1
Definition
What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.
Comment
This element does not describe the usage of the example scenario. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this example scenario.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.copyright
Id
ExampleScenario.copyright
Type
Cardinality
0 - 1
Definition
A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.
Comment
...
Requirements
Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.copyrightLabel
Id
ExampleScenario.copyrightLabel
Type
Cardinality
0 - 1
Definition
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
Comment
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Requirements
Defines the content expected to be rendered in all representations of the artifact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.actor
Id
ExampleScenario.actor
Type
Cardinality
0 - *
Definition
A system or person who shares or receives an instance within the scenario.
Comment
Requirements
This is optional to allow for ExampleScenarios that are still draft
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
exs-19 [warning]
Actor should be referenced in at least one operation
exs-23 [error]
actor.key canot be 'OTHER'
Condition
exs-3
exs-6
exs-7
exs-17
exs-18
Path
ExampleScenario.actor.key
Id
ExampleScenario.actor.key
Type
Cardinality
1 - 1
Definition
A unique string within the scenario that is used to reference the actor.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-6
exs-23
exs-17
exs-18
exs-19
Path
ExampleScenario.actor.type
Id
ExampleScenario.actor.type
Type
Cardinality
1 - 1
Definition
The category of actor - person or system.
Comment
Binding
Strength
required
Description
The type of actor - system or human.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.actor.title
Id
ExampleScenario.actor.title
Type
Cardinality
1 - 1
Definition
The human-readable name for the actor used when rendering the scenario.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-7
Path
ExampleScenario.actor.description
Id
ExampleScenario.actor.description
Type
Cardinality
0 - 1
Definition
An explanation of who/what the actor is and its role in the scenario.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance
Id
ExampleScenario.instance
Type
Cardinality
0 - *
Definition
A single data collection that is shared as part of the scenario.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
exs-1 [error]
StructureVersion is required if structureType is not FHIR (but may still be present even if FHIR)
exs-2 [error]
instance.content is only allowed if there are no instance.versions
exs-10 [error]
Version keys must be unique within an instance
exs-11 [error]
Version titles must be unique within an instance
exs-20 [warning]
Instance should be referenced in at least one location
exs-21 [warning]
Instance version should be referenced in at least one operation
Condition
exs-8
exs-9
exs-14
exs-15
exs-16
Path
ExampleScenario.instance.key
Id
ExampleScenario.instance.key
Type
Cardinality
1 - 1
Definition
A unique string within the scenario that is used to reference the instance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-8
exs-14
exs-15
exs-16
exs-20
exs-21
Path
ExampleScenario.instance.structureType
Id
ExampleScenario.instance.structureType
Type
Cardinality
1 - 1
Definition
A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.
Comment
Binding
Strength
extensible
Description
The structure that defines the instance
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-1
Path
ExampleScenario.instance.structureType.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.structureType.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.structureType.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.instance.structureType.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
ExampleScenario.instance.structureType.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.structureVersion
Id
ExampleScenario.instance.structureVersion
Type
Cardinality
0 - 1
Definition
Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-1
Path
ExampleScenario.instance.structureProfile[x]
Id
ExampleScenario.instance.structureProfile[x]
Type
Cardinality
0 - 1
Definition
Refers to a profile, template or other ruleset the instance adheres to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.title
Id
ExampleScenario.instance.title
Type
Cardinality
1 - 1
Definition
A short descriptive label the instance to be used in tables or diagrams.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-9
Path
ExampleScenario.instance.description
Id
ExampleScenario.instance.description
Type
Cardinality
0 - 1
Definition
An explanation of what the instance contains and what it's for.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.content
Id
ExampleScenario.instance.content
Type
Cardinality
0 - 1
Definition
Points to an instance (typically an example) that shows the data that would corespond to this instance.
Comment
If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-2
Path
ExampleScenario.instance.content.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExampleScenario.instance.content.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.content.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExampleScenario.instance.content.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
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.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.content.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.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.content.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.content.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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
ExampleScenario.instance.content.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.content.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.content.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExampleScenario.instance.version
Id
ExampleScenario.instance.version
Type
Cardinality
0 - *
Definition
Represents the instance as it was at a specific time-point.
Comment
Not used if an instance doesn't change
Requirements
Allows representing the 'same' instance as it evolves throughout the scenario.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-10
exs-11
exs-15
exs-16
exs-2
exs-21
Path
ExampleScenario.instance.version.key
Id
ExampleScenario.instance.version.key
Type
Cardinality
1 - 1
Definition
A unique string within the instance that is used to reference the version of the instance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-10
exs-16
exs-21
Path
ExampleScenario.instance.version.title
Id
ExampleScenario.instance.version.title
Type
Cardinality
1 - 1
Definition
A short descriptive label the version to be used in tables or diagrams.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-11
Path
ExampleScenario.instance.version.description
Id
ExampleScenario.instance.version.description
Type
Cardinality
0 - 1
Definition
An explanation of what this specific version of the instance contains and represents.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.version.content
Id
ExampleScenario.instance.version.content
Type
Cardinality
0 - 1
Definition
Points to an instance (typically an example) that shows the data that would flow at this point in the scenario.
Comment
If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.version.content.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
ExampleScenario.instance.version.content.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.version.content.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
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.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExampleScenario.instance.version.content.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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
ExampleScenario.instance.containedInstance
Id
ExampleScenario.instance.containedInstance
Type
Cardinality
0 - *
Definition
References to other instances that can be found within this instance (e.g. the observations contained in a bundle).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
exs-14 [error]
InstanceReference must be a key of an instance defined in the ExampleScenario
exs-15 [error]
versionReference must be specified if the referenced instance defines versions
exs-16 [error]
versionReference must be a key of a version within the instance pointed to by instanceReference
Path
ExampleScenario.instance.containedInstance.instanceReference
Id
ExampleScenario.instance.containedInstance.instanceReference
Type
Cardinality
1 - 1
Definition
A reference to the key of an instance found within this one.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-14
exs-15
exs-16
exs-20
exs-21
Path
ExampleScenario.instance.containedInstance.versionReference
Id
ExampleScenario.instance.containedInstance.versionReference
Type
Cardinality
0 - 1
Definition
A reference to the key of a specific version of an instance in this instance.
Comment
Required if the referenced instance has versions
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-15
exs-16
exs-21
Path
ExampleScenario.process
Id
ExampleScenario.process
Type
Cardinality
0 - *
Definition
A group of operations that represents a significant step within a scenario.
Comment
Some scenarios might describe only one process.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
exs-5 [error]
Processes must have steps if ExampleScenario status is active or required
Condition
exs-4
exs-12
exs-22
exs-20
exs-21
exs-19
Path
ExampleScenario.process.title
Id
ExampleScenario.process.title
Type
Cardinality
1 - 1
Definition
A short descriptive label the process to be used in tables or diagrams.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-12
Path
ExampleScenario.process.description
Id
ExampleScenario.process.description
Type
Cardinality
0 - 1
Definition
An explanation of what the process represents and what it does.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.preConditions
Id
ExampleScenario.process.preConditions
Type
Cardinality
0 - 1
Definition
Description of the initial state of the actors, environment and data before the process starts.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.postConditions
Id
ExampleScenario.process.postConditions
Type
Cardinality
0 - 1
Definition
Description of the final state of the actors, environment and data after the process has been successfully completed.
Comment
Alternate steps might not result in all post conditions holding
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step
Id
ExampleScenario.process.step
Type
Cardinality
0 - *
Definition
A significant action that occurs as part of the process.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
exs-13 [error]
Alternative titles must be unique within a step
exs-22 [error]
Can have a process, a workflow, one or more operations or none of these, but cannot have a combination
Condition
exs-5
Path
ExampleScenario.process.step.number
Id
ExampleScenario.process.step.number
Type
Cardinality
0 - 1
Definition
The sequential number of the step, e.g. 1.2.5.
Comment
If step numbers are simultaneous, they will be the same. Numbers don't have to be numeric. E.g. '2c)' is a valid step number
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.process
Id
ExampleScenario.process.step.process
Type
Cardinality
0 - 1
Definition
Indicates that the step is a complex sub-process with its own steps.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.workflow
Id
ExampleScenario.process.step.workflow
Type
Cardinality
0 - 1
Definition
Indicates that the step is defined by a seaparate scenario instance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-22
Path
ExampleScenario.process.step.operation
Id
ExampleScenario.process.step.operation
Type
Cardinality
0 - 1
Definition
The step represents a single operation invoked on receiver by sender.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
exs-17 [error]
If specified, initiator must be a key of an actor within the ExampleScenario
exs-18 [error]
If specified, receiver must be a key of an actor within the ExampleScenario
Condition
exs-19
exs-22
Path
ExampleScenario.process.step.operation.type
Id
ExampleScenario.process.step.operation.type
Type
Cardinality
0 - 1
Definition
The standardized type of action (FHIR or otherwise).
Comment
Binding
Strength
extensible
Description
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.title
Id
ExampleScenario.process.step.operation.title
Type
Cardinality
1 - 1
Definition
A short descriptive label the step to be used in tables or diagrams.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.initiator
Id
ExampleScenario.process.step.operation.initiator
Type
Cardinality
0 - 1
Definition
The system that invokes the action/transmits the data.
Comment
This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the initiator is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.)
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-17
exs-19
Path
ExampleScenario.process.step.operation.receiver
Id
ExampleScenario.process.step.operation.receiver
Type
Cardinality
0 - 1
Definition
The system on which the action is invoked/receives the data.
Comment
This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the receiver is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.) In some cases, receiver could be same as sender if representing a local operation
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-18
exs-19
Path
ExampleScenario.process.step.operation.description
Id
ExampleScenario.process.step.operation.description
Type
Cardinality
0 - 1
Definition
An explanation of what the operation represents and what it does.
Comment
This should contain information not already present in the process step. It's more of a description of what the operation in general does - if not already evident from the operation.type
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.initiatorActive
Id
ExampleScenario.process.step.operation.initiatorActive
Type
Cardinality
0 - 1
Definition
If false, the initiator is deactivated right after the operation.
Comment
De-activation of an actor means they have no further role until such time as they are the recipient of an operation.
Requirements
The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.receiverActive
Id
ExampleScenario.process.step.operation.receiverActive
Type
Cardinality
0 - 1
Definition
If false, the receiver is deactivated right after the operation.
Comment
De-activation of an actor means they have no further role until such time as they are the recipient of an operation.
Requirements
The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.request
Id
ExampleScenario.process.step.operation.request
Type
Cardinality
0 - 1
Definition
A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
response
Instance transmitted on invocation response
Path
ExampleScenario.process.step.operation.response
Id
ExampleScenario.process.step.operation.response
Type
Cardinality
0 - 1
Definition
A reference to the instance that is transmitted from receiver to requester as part of the operation's synchronous response (if any).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.alternative
Id
ExampleScenario.process.step.alternative
Type
Cardinality
0 - *
Definition
Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-13
Path
ExampleScenario.process.step.alternative.title
Id
ExampleScenario.process.step.alternative.title
Type
Cardinality
1 - 1
Definition
The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exs-13
Path
ExampleScenario.process.step.alternative.description
Id
ExampleScenario.process.step.alternative.description
Type
Cardinality
0 - 1
Definition
A human-readable description of the alternative explaining when the alternative should occur rather than the base step.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.alternative.step
Id
ExampleScenario.process.step.alternative.step
Type
Cardinality
0 - *
Definition
Indicates the operation, sub-process or scenario that happens if the alternative option is selected.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.pause
Id
ExampleScenario.process.step.pause
Type
Cardinality
0 - 1
Definition
If true, indicates that, following this step, there is a pause in the flow and the subsequent step will occur at some later time (triggered by some event).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children