Summary
Diagnostics
Care Provision
Request & Response
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Documents
Terminology
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
Encounter
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
StructureDefinition
StructureMap
ValueSet
default
Example of workflow instance.
ExampleScenario
Path
ExampleScenario
Id
ExampleScenario
Cardinality
0 - *
Definition
Example of workflow instance.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5 [error]
If a resource is contained in another resource, it SHALL NOT have a security label
dom-6 [warning]
A resource should have narrative for robust management
esc-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
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 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
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.
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.
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 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
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
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, a 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 [Rendered Value extension](extension-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
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 high 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-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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
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).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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.
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.
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, a 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 [Rendered Value extension](extension-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
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
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].
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.name
Id
ExampleScenario.name
Type
Cardinality
0 - 1
Definition
A natural language name identifying the example scenario. 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 alphanumeric type name to ensure that it is machine-processing friendly.
Requirements
Support human navigation and code generation.
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.
Binding
Strength
required
Description
The lifecycle status of an artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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 published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').
Comment
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.
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 that published 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.
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
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
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.
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.
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 high 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.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
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 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
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
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
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 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
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
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.
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 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
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
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.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
nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.
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.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.actor
Id
ExampleScenario.actor
Type
Cardinality
0 - *
Definition
Actor participating in the resource.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
ExampleScenario.actor.actorId
Id
ExampleScenario.actor.actorId
Type
Cardinality
1 - 1
Definition
ID or acronym of actor.
Comment
should this be called ID or acronym?
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.actor.type
Id
ExampleScenario.actor.type
Type
Cardinality
1 - 1
Definition
The type 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.name
Id
ExampleScenario.actor.name
Type
Cardinality
0 - 1
Definition
The name of the actor as shown in the page.
Comment
Cardinality: is name and description 1..1?
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.actor.description
Id
ExampleScenario.actor.description
Type
Cardinality
0 - 1
Definition
The description of the actor.
Comment
Cardinality: is name and description 1..1?
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance
Id
ExampleScenario.instance
Type
Cardinality
0 - *
Definition
Each resource and each version that is present in the workflow.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
ExampleScenario.instance.resourceId
Id
ExampleScenario.instance.resourceId
Type
Cardinality
1 - 1
Definition
The id of the resource for referencing.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.resourceType
Id
ExampleScenario.instance.resourceType
Type
Cardinality
1 - 1
Definition
The type of the resource.
Comment
Binding
Strength
required
Description
The type of resource.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.name
Id
ExampleScenario.instance.name
Type
Cardinality
0 - 1
Definition
A short name for the resource instance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.description
Id
ExampleScenario.instance.description
Type
Cardinality
0 - 1
Definition
Human-friendly description of the resource instance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.version
Id
ExampleScenario.instance.version
Type
Cardinality
0 - *
Definition
A specific version of the resource.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
ExampleScenario.instance.version.versionId
Id
ExampleScenario.instance.version.versionId
Type
Cardinality
1 - 1
Definition
The identifier of a specific version of a resource.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.version.description
Id
ExampleScenario.instance.version.description
Type
Cardinality
1 - 1
Definition
The description of the resource version.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.containedInstance
Id
ExampleScenario.instance.containedInstance
Type
Cardinality
0 - *
Definition
Resources contained in the instance (e.g. the observations contained in a bundle).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
ExampleScenario.instance.containedInstance.resourceId
Id
ExampleScenario.instance.containedInstance.resourceId
Type
Cardinality
1 - 1
Definition
Each resource contained in the instance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.instance.containedInstance.versionId
Id
ExampleScenario.instance.containedInstance.versionId
Type
Cardinality
0 - 1
Definition
A specific version of a resource contained in the instance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process
Id
ExampleScenario.process
Type
Cardinality
0 - *
Definition
Each major process - a group of operations.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
ExampleScenario.process.title
Id
ExampleScenario.process.title
Type
Cardinality
1 - 1
Definition
The diagram title of the group of operations.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.description
Id
ExampleScenario.process.description
Type
Cardinality
0 - 1
Definition
A longer description of the group of operations.
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 initial status 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 final status after the process ends.
Comment
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
Each step of the process.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
ExampleScenario.process.step.process
Id
ExampleScenario.process.step.process
Type
Cardinality
0 - *
Definition
Nested process.
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 there is a pause in the flow.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation
Id
ExampleScenario.process.step.operation
Type
Cardinality
0 - 1
Definition
Each interaction or action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
ExampleScenario.process.step.operation.number
Id
ExampleScenario.process.step.operation.number
Type
Cardinality
1 - 1
Definition
The sequential number of the interaction, e.g. 1.2.5.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.type
Id
ExampleScenario.process.step.operation.type
Type
Cardinality
0 - 1
Definition
The type of operation - CRUD.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.name
Id
ExampleScenario.process.step.operation.name
Type
Cardinality
0 - 1
Definition
The human-friendly name of the interaction.
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
Who starts the transaction.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.receiver
Id
ExampleScenario.process.step.operation.receiver
Type
Cardinality
0 - 1
Definition
Who receives the transaction.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.process.step.operation.description
Id
ExampleScenario.process.step.operation.description
Type
Cardinality
0 - 1
Definition
A comment to be inserted in the diagram.
Comment
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
Whether the initiator is deactivated right after the transaction.
Comment
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
Whether the receiver is deactivated right after the transaction.
Comment
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
Each resource instance used by the initiator.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
response
Each resource instance used by the responder
Path
ExampleScenario.process.step.operation.response
Id
ExampleScenario.process.step.operation.response
Type
Cardinality
0 - 1
Definition
Each resource instance used by the responder.
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 operations on the base step in exceptional/atypical circumstances.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
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
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
What happens in each alternative option.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
ExampleScenario.workflow
Id
ExampleScenario.workflow
Type
Cardinality
0 - *
Definition
Another nested workflow.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children