Complex
Primitive
ActivityDefinition
CapabilityStatement
CodeSystem
Composition
ConceptMap
Encounter
Library
List
Measure
MessageHeader
Observation
Patient
PlanDefinition
Questionnaire
Resource
ServiceDefinition
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for CapabilityStatement Resource
CapabilityStatement
Path
CapabilityStatement
Id
CapabilityStatement
Cardinality
1 - 1
Definition
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1 [error]
If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
cpb-8 [error]
There can only be one REST declaration per mode.
cpb-7 [error]
The set of documents must be unique by the combination of profile and mode.
cpb-15 [error]
Capability Statements of kind 'instance' do not have implementation elements.
cpb-3 [error]
Messaging end-point is required (and is only permitted) when a statement is for an implementation.
cpb-14 [error]
Capability Statements of kind 'requirements' do not have software or implementation elements.
cpb-2 [error]
A Capability Statement SHALL have at least one of description, software, or implementation element.
cpb-1 [error]
A Capability Statement SHALL have at least one of REST, messaging or document element.
Path
CapabilityStatement.url
Id
CapabilityStatement.url
Type
Cardinality
0 - 1
Definition
An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
Comment
Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.
Requirements
Allows the capability statement to be referenced by a single globally unique identifier.
Path
CapabilityStatement.version
Id
CapabilityStatement.version
Type
Cardinality
0 - 1
Definition
The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the capability statement with the format [url]|[version].
Path
CapabilityStatement.name
Id
CapabilityStatement.name
Type
Cardinality
0 - 1
Definition
A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Comment
The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.
Requirements
Support human navigation and code generation.
Path
CapabilityStatement.title
Id
CapabilityStatement.title
Type
Cardinality
0 - 1
Definition
A short, descriptive, user-friendly title for the capability statement.
Comment
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Path
CapabilityStatement.status
Id
CapabilityStatement.status
Type
Cardinality
1 - 1
Definition
The status of this capability statement. Enables tracking the life-cycle of the content.
Comment
Allows filtering of capability statements that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired capability statement without due consideration. This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.
Path
CapabilityStatement.experimental
Id
CapabilityStatement.experimental
Type
Cardinality
0 - 1
Definition
A boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Comment
Allows filtering of capability statement that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental capability statement in production.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement.
Path
CapabilityStatement.date
Id
CapabilityStatement.date
Type
Cardinality
1 - 1
Definition
The date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
Comment
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Path
CapabilityStatement.publisher
Id
CapabilityStatement.publisher
Type
Cardinality
0 - 1
Definition
The name of the individual or organization that published the capability statement.
Comment
Usually an organization, but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. 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 capability statement. This item SHOULD be populated unless the information is available from context.
Requirements
Helps establish the "authority/credibility" of the capability statement. May also allow for contact.
Path
CapabilityStatement.contact
Id
CapabilityStatement.contact
Type
Cardinality
0 - *
Definition
Contact details to assist a user in finding and communicating with the publisher.
Comment
May be a web site, an email address, a telephone number, etc.
Path
CapabilityStatement.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Path
CapabilityStatement.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Path
CapabilityStatement.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Condition
cpt-2
Path
CapabilityStatement.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Path
CapabilityStatement.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Path
CapabilityStatement.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Path
CapabilityStatement.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Path
CapabilityStatement.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Condition
per-1
Path
CapabilityStatement.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
CapabilityStatement.description
Id
CapabilityStatement.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
Comment
This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). This does not need to be populated if the description is adequately implied by the software or implementation details.
Condition
cpb-2
Path
CapabilityStatement.useContext
Id
CapabilityStatement.useContext
Type
Cardinality
0 - *
Definition
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
Comment
When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Path
CapabilityStatement.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Path
CapabilityStatement.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
CapabilityStatement.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
CapabilityStatement.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
CapabilityStatement.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
CapabilityStatement.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
CapabilityStatement.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Path
CapabilityStatement.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
CapabilityStatement.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
CapabilityStatement.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
CapabilityStatement.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
CapabilityStatement.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
CapabilityStatement.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
CapabilityStatement.jurisdiction
Id
CapabilityStatement.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the capability statement is intended to be used.
Comment
It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.
Path
CapabilityStatement.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
CapabilityStatement.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
CapabilityStatement.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
CapabilityStatement.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
CapabilityStatement.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
CapabilityStatement.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
CapabilityStatement.purpose
Id
CapabilityStatement.purpose
Type
Cardinality
0 - 1
Definition
Explaination of why this capability statement is needed and why it has been designed as it has.
Comment
This element does not describe the usage of the capability statement 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 capability statement.
Path
CapabilityStatement.copyright
Id
CapabilityStatement.copyright
Type
Cardinality
0 - 1
Definition
A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
Comment
Requirements
Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content.
Path
CapabilityStatement.kind
Id
CapabilityStatement.kind
Type
Cardinality
1 - 1
Definition
The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
Comment
Requirements
Allow searching the 3 modes.
Path
CapabilityStatement.instantiates
Id
CapabilityStatement.instantiates
Type
Cardinality
0 - *
Definition
Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
Comment
HL7 defines the following Services: [Terminology Service](terminology-service.html).
Many [Implementation Guides](http://fhir.org/guides/registry) define additional services.
Path
CapabilityStatement.software
Id
CapabilityStatement.software
Type
Cardinality
0 - 1
Definition
Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpb-2
Path
CapabilityStatement.software.name
Id
CapabilityStatement.software.name
Type
Cardinality
1 - 1
Definition
Name software is known by.
Comment
Path
CapabilityStatement.software.version
Id
CapabilityStatement.software.version
Type
Cardinality
0 - 1
Definition
The version identifier for the software covered by this statement.
Comment
If possible, a version should be specified, as statements are likely to be different for different versions of software.
Path
CapabilityStatement.software.releaseDate
Id
CapabilityStatement.software.releaseDate
Type
Cardinality
0 - 1
Definition
Date this version of the software was released.
Comment
Path
CapabilityStatement.implementation
Id
CapabilityStatement.implementation
Type
Cardinality
0 - 1
Definition
Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpb-2
Path
CapabilityStatement.implementation.description
Id
CapabilityStatement.implementation.description
Type
Cardinality
1 - 1
Definition
Information about the specific installation that this capability statement relates to.
Comment
Path
CapabilityStatement.implementation.url
Id
CapabilityStatement.implementation.url
Type
Cardinality
0 - 1
Definition
An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
Comment
Path
CapabilityStatement.fhirVersion
Id
CapabilityStatement.fhirVersion
Type
Cardinality
1 - 1
Definition
The version of the FHIR specification on which this capability statement is based.
Comment
Path
CapabilityStatement.acceptUnknown
Id
CapabilityStatement.acceptUnknown
Type
Cardinality
1 - 1
Definition
A code that indicates whether the application accepts unknown elements or extensions when reading resources.
Comment
Unknown elements in a resource can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence accepting unknown elements is about inter-version compatibility.
Applications are recommended to accept unknown extensions and elements ('both'), but this is not always possible.
Path
CapabilityStatement.format
Id
CapabilityStatement.format
Type
Cardinality
1 - *
Definition
A list of the formats supported by this implementation using their content types.
Comment
"xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.
Path
CapabilityStatement.patchFormat
Id
CapabilityStatement.patchFormat
Type
Cardinality
0 - *
Definition
A list of the patch formats supported by this implementation using their content types.
Comment
At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.
Path
CapabilityStatement.implementationGuide
Id
CapabilityStatement.implementationGuide
Type
Cardinality
0 - *
Definition
A list of implementation guides that the server does (or should) support in their entirety.
Comment
Path
CapabilityStatement.profile
Id
CapabilityStatement.profile
Type
Cardinality
0 - *
Definition
A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
Comment
Supported profiles are different than the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile). Typically, supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However, they do not need to describe more than one resource.
Path
CapabilityStatement.profile.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
CapabilityStatement.profile.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.profile.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
CapabilityStatement.profile.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
CapabilityStatement.profile.Reference.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 translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
CapabilityStatement.profile.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
CapabilityStatement.profile.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
CapabilityStatement.profile.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
CapabilityStatement.profile.Reference.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.
Condition
per-1
Path
CapabilityStatement.profile.Reference.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 that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
CapabilityStatement.profile.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
CapabilityStatement.profile.Reference.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.
Condition
ref-1
Path
CapabilityStatement.profile.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.profile.Reference.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.
Path
CapabilityStatement.profile.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
CapabilityStatement.rest
Id
CapabilityStatement.rest
Type
Cardinality
0 - *
Definition
A definition of the restful capabilities of the solution, if any.
Comment
Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
cpb-9 [error]
A given resource can only be described once per RESTful mode.
Condition
cpb-1
Path
CapabilityStatement.rest.mode
Id
CapabilityStatement.rest.mode
Type
Cardinality
1 - 1
Definition
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
Comment
Path
CapabilityStatement.rest.documentation
Id
CapabilityStatement.rest.documentation
Type
Cardinality
0 - 1
Definition
Information about the system's restful capabilities that apply across all applications, such as security.
Comment
Path
CapabilityStatement.rest.security
Id
CapabilityStatement.rest.security
Type
Cardinality
0 - 1
Definition
Information about security implementation from an interface perspective - what a client needs to know.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.rest.security.cors
Id
CapabilityStatement.rest.security.cors
Type
Cardinality
0 - 1
Definition
Server adds CORS headers when responding to requests - this enables javascript applications to use the server.
Comment
The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.
Path
CapabilityStatement.rest.security.service
Id
CapabilityStatement.rest.security.service
Type
Cardinality
0 - *
Definition
Types of security services that are supported/required by the system.
Comment
Path
CapabilityStatement.rest.security.service.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
CapabilityStatement.rest.security.description
Id
CapabilityStatement.rest.security.description
Type
Cardinality
0 - 1
Definition
General description of how security works.
Comment
Path
CapabilityStatement.rest.security.certificate
Id
CapabilityStatement.rest.security.certificate
Type
Cardinality
0 - *
Definition
Certificates associated with security profiles.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.rest.security.certificate.type
Id
CapabilityStatement.rest.security.certificate.type
Type
Cardinality
0 - 1
Definition
Mime type for a certificate.
Comment
Path
CapabilityStatement.rest.security.certificate.blob
Id
CapabilityStatement.rest.security.certificate.blob
Type
Cardinality
0 - 1
Definition
Actual certificate.
Comment
Path
CapabilityStatement.rest.resource
Id
CapabilityStatement.rest.resource
Type
Cardinality
0 - *
Definition
A specification of the restful capabilities of the solution for a specific resource type.
Comment
Max of one repetition per resource type.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
cpb-12 [error]
Search parameter names must be unique in the context of a resource.
Path
CapabilityStatement.rest.resource.type
Id
CapabilityStatement.rest.resource.type
Type
Cardinality
1 - 1
Definition
A type of resource exposed via the restful interface.
Comment
Path
CapabilityStatement.rest.resource.profile
Id
CapabilityStatement.rest.resource.profile
Type
Cardinality
0 - 1
Definition
A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).
Comment
The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.
Path
CapabilityStatement.rest.resource.profile.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
CapabilityStatement.rest.resource.profile.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.rest.resource.profile.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
CapabilityStatement.rest.resource.documentation
Id
CapabilityStatement.rest.resource.documentation
Type
Cardinality
0 - 1
Definition
Additional information about the resource type used by the system.
Comment
Path
CapabilityStatement.rest.resource.interaction
Id
CapabilityStatement.rest.resource.interaction
Type
Cardinality
1 - *
Definition
Identifies a restful operation supported by the solution.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
code
read | vread | update | patch | delete | history-instance | history-type | create | search-type
Path
CapabilityStatement.rest.resource.interaction.code
Id
CapabilityStatement.rest.resource.interaction.code
Type
Cardinality
1 - 1
Definition
Coded identifier of the operation, supported by the system resource.
Comment
Path
CapabilityStatement.rest.resource.interaction.documentation
Id
CapabilityStatement.rest.resource.interaction.documentation
Type
Cardinality
0 - 1
Definition
Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.
Comment
Requirements
REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.
Path
CapabilityStatement.rest.resource.versioning
Id
CapabilityStatement.rest.resource.versioning
Type
Cardinality
0 - 1
Definition
This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
Comment
If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.
Path
CapabilityStatement.rest.resource.readHistory
Id
CapabilityStatement.rest.resource.readHistory
Type
Cardinality
0 - 1
Definition
A flag for whether the server is able to return past versions as part of the vRead operation.
Comment
It is useful to support the vRead operation for current operations, even if past versions aren't available.
Path
CapabilityStatement.rest.resource.updateCreate
Id
CapabilityStatement.rest.resource.updateCreate
Type
Cardinality
0 - 1
Definition
A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
Comment
Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.
Path
CapabilityStatement.rest.resource.conditionalCreate
Id
CapabilityStatement.rest.resource.conditionalCreate
Type
Cardinality
0 - 1
Definition
A flag that indicates that the server supports conditional create.
Comment
Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.
Path
CapabilityStatement.rest.resource.conditionalRead
Id
CapabilityStatement.rest.resource.conditionalRead
Type
Cardinality
0 - 1
Definition
A code that indicates how the server supports conditional read.
Comment
Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.
Path
CapabilityStatement.rest.resource.conditionalUpdate
Id
CapabilityStatement.rest.resource.conditionalUpdate
Type
Cardinality
0 - 1
Definition
A flag that indicates that the server supports conditional update.
Comment
Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.
Path
CapabilityStatement.rest.resource.conditionalDelete
Id
CapabilityStatement.rest.resource.conditionalDelete
Type
Cardinality
0 - 1
Definition
A code that indicates how the server supports conditional delete.
Comment
Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.
Path
CapabilityStatement.rest.resource.referencePolicy
Id
CapabilityStatement.rest.resource.referencePolicy
Type
Cardinality
0 - *
Definition
A set of flags that defines how references are supported.
Comment
Path
CapabilityStatement.rest.resource.searchInclude
Id
CapabilityStatement.rest.resource.searchInclude
Type
Cardinality
0 - *
Definition
A list of _include values supported by the server.
Comment
If this list is empty, the server does not support includes.
Path
CapabilityStatement.rest.resource.searchRevInclude
Id
CapabilityStatement.rest.resource.searchRevInclude
Type
Cardinality
0 - *
Definition
A list of _revinclude (reverse include) values supported by the server.
Comment
If this list is empty, the server does not support reverse includes.
Path
CapabilityStatement.rest.resource.searchParam
Id
CapabilityStatement.rest.resource.searchParam
Type
Cardinality
0 - *
Definition
Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.rest.resource.searchParam.name
Id
CapabilityStatement.rest.resource.searchParam.name
Type
Cardinality
1 - 1
Definition
The name of the search parameter used in the interface.
Comment
Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.
Path
CapabilityStatement.rest.resource.searchParam.definition
Id
CapabilityStatement.rest.resource.searchParam.definition
Type
Cardinality
0 - 1
Definition
An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url]()).
Comment
This SHOULD be present, and matches refers to a SearchParameter by its canonical url. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource.
Path
CapabilityStatement.rest.resource.searchParam.type
Id
CapabilityStatement.rest.resource.searchParam.type
Type
Cardinality
1 - 1
Definition
The type of value a search parameter refers to, and how the content is interpreted.
Comment
While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.
Path
CapabilityStatement.rest.resource.searchParam.documentation
Id
CapabilityStatement.rest.resource.searchParam.documentation
Type
Cardinality
0 - 1
Definition
This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
Comment
Path
CapabilityStatement.rest.interaction
Id
CapabilityStatement.rest.interaction
Type
Cardinality
0 - *
Definition
A specification of restful operations supported by the system.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.rest.interaction.code
Id
CapabilityStatement.rest.interaction.code
Type
Cardinality
1 - 1
Definition
A coded identifier of the operation, supported by the system.
Comment
Path
CapabilityStatement.rest.interaction.documentation
Id
CapabilityStatement.rest.interaction.documentation
Type
Cardinality
0 - 1
Definition
Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
Comment
Path
CapabilityStatement.rest.searchParam
Id
CapabilityStatement.rest.searchParam
Type
Cardinality
0 - *
Definition
Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
Comment
Typically, the only search parameters supported for all searchse are those that apply to all resources - tags, profiles, text search etc.
Path
CapabilityStatement.rest.operation
Id
CapabilityStatement.rest.operation
Type
Cardinality
0 - *
Definition
Definition of an operation or a named query together with its parameters and their meaning and type.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.rest.operation.name
Id
CapabilityStatement.rest.operation.name
Type
Cardinality
1 - 1
Definition
The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.
Comment
The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the "$" portion that is always included in the URL.
Path
CapabilityStatement.rest.operation.definition
Id
CapabilityStatement.rest.operation.definition
Type
Cardinality
1 - 1
Definition
Where the formal definition can be found.
Comment
This can be used to build an HTML form to invoke the operation, for instance.
Path
CapabilityStatement.rest.operation.definition.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
CapabilityStatement.rest.operation.definition.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.rest.operation.definition.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
CapabilityStatement.rest.compartment
Id
CapabilityStatement.rest.compartment
Type
Cardinality
0 - *
Definition
An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .
Comment
At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).
Path
CapabilityStatement.messaging
Id
CapabilityStatement.messaging
Type
Cardinality
0 - *
Definition
A description of the messaging capabilities of the solution.
Comment
Multiple repetitions allow the documentation of multiple endpoints per solution.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
cpb-16 [error]
A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both.
Condition
cpb-1
Path
CapabilityStatement.messaging.endpoint
Id
CapabilityStatement.messaging.endpoint
Type
Cardinality
0 - *
Definition
An endpoint (network accessible address) to which messages and/or replies are to be sent.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.messaging.endpoint.protocol
Id
CapabilityStatement.messaging.endpoint.protocol
Type
Cardinality
1 - 1
Definition
A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
Comment
Path
CapabilityStatement.messaging.endpoint.protocol.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
CapabilityStatement.messaging.endpoint.protocol.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
CapabilityStatement.messaging.endpoint.protocol.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
CapabilityStatement.messaging.endpoint.protocol.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
CapabilityStatement.messaging.endpoint.protocol.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
CapabilityStatement.messaging.endpoint.address
Id
CapabilityStatement.messaging.endpoint.address
Type
Cardinality
1 - 1
Definition
The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier.
Comment
Path
CapabilityStatement.messaging.reliableCache
Id
CapabilityStatement.messaging.reliableCache
Type
Cardinality
0 - 1
Definition
Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
Comment
If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.
Path
CapabilityStatement.messaging.documentation
Id
CapabilityStatement.messaging.documentation
Type
Cardinality
0 - 1
Definition
Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
Comment
Path
CapabilityStatement.messaging.supportedMessage
Id
CapabilityStatement.messaging.supportedMessage
Type
Cardinality
0 - *
Definition
References to message definitions for messages this system can send or receive.
Comment
This is a proposed alternative to the messaging.event structure.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.messaging.supportedMessage.mode
Id
CapabilityStatement.messaging.supportedMessage.mode
Type
Cardinality
1 - 1
Definition
The mode of this event declaration - whether application is sender or receiver.
Comment
Path
CapabilityStatement.messaging.supportedMessage.definition
Id
CapabilityStatement.messaging.supportedMessage.definition
Type
Cardinality
1 - 1
Definition
Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
Comment
Path
CapabilityStatement.messaging.supportedMessage.definition.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
CapabilityStatement.messaging.supportedMessage.definition.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.messaging.supportedMessage.definition.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
CapabilityStatement.messaging.event
Id
CapabilityStatement.messaging.event
Type
Cardinality
0 - *
Definition
A description of the solution's support for an event at this end-point.
Comment
The same event may be listed up to two times - once as sender and once as receiver.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
CapabilityStatement.messaging.event.code
Id
CapabilityStatement.messaging.event.code
Type
Cardinality
1 - 1
Definition
A coded identifier of a supported messaging event.
Comment
Path
CapabilityStatement.messaging.event.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
CapabilityStatement.messaging.event.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
CapabilityStatement.messaging.event.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
CapabilityStatement.messaging.event.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
CapabilityStatement.messaging.event.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
CapabilityStatement.messaging.event.category
Id
CapabilityStatement.messaging.event.category
Type
Cardinality
0 - 1
Definition
The impact of the content of the message.
Comment
Path
CapabilityStatement.messaging.event.mode
Id
CapabilityStatement.messaging.event.mode
Type
Cardinality
1 - 1
Definition
The mode of this event declaration - whether an application is a sender or receiver.
Comment
Path
CapabilityStatement.messaging.event.focus
Id
CapabilityStatement.messaging.event.focus
Type
Cardinality
1 - 1
Definition
A resource associated with the event. This is the resource that defines the event.
Comment
This SHALL be provided if the event type supports multiple different resource types.
Path
CapabilityStatement.messaging.event.request
Id
CapabilityStatement.messaging.event.request
Type
Cardinality
1 - 1
Definition
Information about the request for this event.
Comment
Path
CapabilityStatement.messaging.event.request.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
CapabilityStatement.messaging.event.request.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.messaging.event.request.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
CapabilityStatement.messaging.event.response
Id
CapabilityStatement.messaging.event.response
Type
Cardinality
1 - 1
Definition
Information about the response for this event.
Comment
Path
CapabilityStatement.messaging.event.response.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
CapabilityStatement.messaging.event.response.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.messaging.event.response.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
CapabilityStatement.messaging.event.documentation
Id
CapabilityStatement.messaging.event.documentation
Type
Cardinality
0 - 1
Definition
Guidance on how this event is handled, such as internal system trigger points, business rules, etc.
Comment
Path
CapabilityStatement.document
Id
CapabilityStatement.document
Type
Cardinality
0 - *
Definition
A document definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpb-1
Path
CapabilityStatement.document.mode
Id
CapabilityStatement.document.mode
Type
Cardinality
1 - 1
Definition
Mode of this document declaration - whether an application is a producer or consumer.
Comment
Path
CapabilityStatement.document.documentation
Id
CapabilityStatement.document.documentation
Type
Cardinality
0 - 1
Definition
A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.
Comment
Path
CapabilityStatement.document.profile
Id
CapabilityStatement.document.profile
Type
Cardinality
1 - 1
Definition
A constraint on a resource used in the document.
Comment
The first resource is the document resource.
Path
CapabilityStatement.document.profile.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
CapabilityStatement.document.profile.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
CapabilityStatement.document.profile.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
CapabilityStatement.document.profile.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
CapabilityStatement.document.profile.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
CapabilityStatement.document.profile.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
CapabilityStatement.document.profile.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
CapabilityStatement.document.profile.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
CapabilityStatement.document.profile.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.