Profile for Get Document List API


This profile is a bundle resource that is used to hold a collection of DocumentReference resources, for the retrieval of documents based on certain parameters (See API - Get Document List).

These are the details for these resources:

Name Canonical_URL Status Version
Bundle http://hl7.org/fhir/StructureDefinition/Bundle active 5.0.0
DocumentReference http://fhir.synapxe.sg/StructureDefinition/profile-documentreference active 5.0.0

Resource content


These are different views on these resources:

Bundle

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ I0..1Identifier
typeΣ I1..1codeBinding
timestampΣ I0..1instant
totalΣ I0..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ I1..1codeBinding
urlΣ I1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ I0..1uri
resourceΣ I0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
methodΣ I1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
issuesΣ I0..1OperationOutcome
Bundle
DefinitionA container for a collection of resources.
Cardinality0...*
Invariants
  • bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
    (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
  • bdl-9: A document must have an identifier with a system and a value
    type = 'document' implies (identifier.system.exists() and identifier.value.exists())
  • bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
    type = 'document' implies issues.empty()
  • bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
    issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
  • bdl-18: Self link is required for searchsets.
    type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
  • bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource
    type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
  • bdl-12: A message must have a MessageHeader as the first resource
    type = 'message' implies entry.first().resource.is(MessageHeader)
  • bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
    type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
  • bdl-14: entry.request.method PATCH not allowed for history
    type = 'history' implies entry.request.method != 'PATCH'
  • bdl-11: A document must have a Composition as the first resource
    type = 'document' implies entry.first().resource.is(Composition)
  • bdl-10: A document must have a date
    type = 'document' implies (timestamp.hasValue())
  • bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
    type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
  • bdl-1: total only when a search or history
    total.empty() or (type = 'searchset') or (type = 'history')
  • bdl-2: entry.search only when a search
    (type = 'searchset') or entry.search.empty()
  • bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
    type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
  • bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
    type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
  • bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
    type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • w5: infrastructure.structure
  • v2: N/A
  • rim: N/A
  • cda: ClinicalDocument, if bundle.type = document
Bundle.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Bundle.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Bundle.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.identifier
DefinitionA persistent identifier for the bundle that won't change as a bundle is copied from server to server.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • cda: ClinicalDocument.id
Bundle.type
DefinitionIndicates the purpose of this bundle - how it is intended to be used.
Cardinality1...1
Typecode
Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (required)
SummaryTrue
Comments

It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
Bundle.timestamp
DefinitionThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

Usage:

  • document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
  • message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
  • history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
  • searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
  • transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • cda: ClinicalDocument.effectiveTime
Bundle.total
DefinitionIf a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
Cardinality0...1
TypeunsignedInt
SummaryTrue
Comments

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.link
DefinitionA series of links that provide context to this bundle.
Cardinality0...*
TypeBackboneElement
SummaryTrue
Comments

Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.link.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.link.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.link.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.link.relation
DefinitionA name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
Cardinality1...1
Typecode
BindingLinkRelationTypes (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.link.url
DefinitionThe reference details for the link.
Cardinality1...1
Typeuri
SummaryTrue
Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry
DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Cardinality0...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
Bundle.entry.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.link
DefinitionA series of links that provide context to this entry.
Cardinality0...*
Typesee (link)
SummaryTrue
Bundle.entry.fullUrl
DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation.
Cardinality0...1
Typeuri
SummaryTrue
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.resource
DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.
Cardinality0...1
TypeResource
SummaryTrue
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
Bundle.entry.search
DefinitionInformation about the search process that lead to the creation of this entry.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.search.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.search.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.search.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.search.mode
DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Cardinality0...1
Typecode
Binding

Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

SearchEntryMode (required)
SummaryTrue
Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.search.score
DefinitionWhen searching, the server's search ranking score for the entry.
Cardinality0...1
Typedecimal
SummaryTrue
Comments

Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See Patient Match for the EMPI search which relates to this element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request
DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.request.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.request.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.request.method
DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
Cardinality1...1
Typecode
Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.url
DefinitionThe URL for this entry, relative to the root (the address to which the request is posted).
Cardinality1...1
Typeuri
SummaryTrue
Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifNoneMatch
DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifModifiedSince
DefinitionOnly perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Cardinality0...1
Typeinstant
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifMatch
DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifNoneExist
DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response
DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.response.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.response.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.response.status
DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
Cardinality1...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.location
DefinitionThe location header created by processing this operation, populated if the operation returns a location.
Cardinality0...1
Typeuri
SummaryTrue
Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.etag
DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).
Cardinality0...1
Typestring
SummaryTrue
Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.lastModified
DefinitionThe date/time that the resource was modified on the server.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.outcome
DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
Cardinality0...1
TypeResource
SummaryTrue
Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.

Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
Bundle.signature
DefinitionDigital Signature - base64 encoded. XML-DSig or a JWS.
Cardinality0...1
TypeSignature
SummaryTrue
Requirements

A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.

Comments

The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Bundle.issues
DefinitionCaptures issues and warnings that relate to the construction of the Bundle and the content within it.
Cardinality0...1
TypeOperationOutcome
SummaryTrue
Comments

Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.

Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: 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
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: Entity, Role, or Act
  • w5: infrastructure.exchange
  • rim: Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Bundle" />
    <meta>
        <lastUpdated value="2023-03-26T15:21:02.749+11:00" />
    </meta>
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category">
        <valueString value="Foundation.Other" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category">
        <valueCode value="not-classified" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <url value="http://hl7.org/fhir/StructureDefinition/Bundle" />
    <version value="5.0.0" />
    <name value="Bundle" />
    <status value="active" />
    <experimental value="false" />
    <date value="2023-03-26T15:21:02+11:00" />
    <publisher value="Health Level Seven International (FHIR Infrastructure)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://www.hl7.org/Special/committees/fiwg/index.cfm" />
        </telecom>
    </contact>
    <description value="A container for a collection of resources." />
    <jurisdiction>
        <coding>
            <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" />
            <code value="001" />
            <display value="World" />
        </coding>
    </jurisdiction>
    <fhirVersion value="5.0.0" />
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 V2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="cda" />
        <uri value="http://hl7.org/v3/cda" />
        <name value="CDA (R2)" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Bundle" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Resource" />
    <derivation value="specialization" />
    <snapshot>
        <element id="Bundle">
            <path value="Bundle" />
            <short value="Contains a collection of resources" />
            <definition value="A container for a collection of resources." />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Bundle" />
                <min value="0" />
                <max value="*" />
            </base>
            <constraint>
                <key value="bdl-1" />
                <severity value="error" />
                <human value="total only when a search or history" />
                <expression value="total.empty() or (type = &#39;searchset&#39;) or (type = &#39;history&#39;)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-2" />
                <severity value="error" />
                <human value="entry.search only when a search" />
                <expression value="(type = &#39;searchset&#39;) or entry.search.empty()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-7" />
                <severity value="error" />
                <human value="FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)" />
                <expression value="(type = &#39;history&#39;) or entry.where(fullUrl.exists()).select(fullUrl&amp;iif(resource.meta.versionId.exists(), resource.meta.versionId, &#39;&#39;)).isDistinct()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-9" />
                <severity value="error" />
                <human value="A document must have an identifier with a system and a value" />
                <expression value="type = &#39;document&#39; implies (identifier.system.exists() and identifier.value.exists())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-10" />
                <severity value="error" />
                <human value="A document must have a date" />
                <expression value="type = &#39;document&#39; implies (timestamp.hasValue())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-11" />
                <severity value="error" />
                <human value="A document must have a Composition as the first resource" />
                <expression value="type = &#39;document&#39; implies entry.first().resource.is(Composition)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-12" />
                <severity value="error" />
                <human value="A message must have a MessageHeader as the first resource" />
                <expression value="type = &#39;message&#39; implies entry.first().resource.is(MessageHeader)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-13" />
                <severity value="error" />
                <human value="A subscription-notification must have a SubscriptionStatus as the first resource" />
                <expression value="type = &#39;subscription-notification&#39; implies entry.first().resource.is(SubscriptionStatus)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-14" />
                <severity value="error" />
                <human value="entry.request.method PATCH not allowed for history" />
                <expression value="type = &#39;history&#39; implies entry.request.method != &#39;PATCH&#39;" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-15" />
                <severity value="error" />
                <human value="Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated" />
                <expression value="type=&#39;transaction&#39; or type=&#39;transaction-response&#39; or type=&#39;batch&#39; or type=&#39;batch-response&#39; or entry.all(fullUrl.exists() or request.method=&#39;POST&#39;)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-16" />
                <severity value="error" />
                <human value="Issue.severity for all issues within the OperationOutcome must be either &#39;information&#39; or &#39;warning&#39;." />
                <expression value="issues.exists() implies (issues.issue.severity = &#39;information&#39; or issues.issue.severity = &#39;warning&#39;)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-17" />
                <severity value="error" />
                <human value="Use and meaning of issues for documents has not been validated because the content will not be rendered in the document." />
                <expression value="type = &#39;document&#39; implies issues.empty()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-18" />
                <severity value="error" />
                <human value="Self link is required for searchsets." />
                <expression value="type = &#39;searchset&#39; implies link.where(relation = &#39;self&#39; and url.exists()).exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3a" />
                <severity value="error" />
                <human value="For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements" />
                <expression value="type in (&#39;document&#39; | &#39;message&#39; | &#39;searchset&#39; | &#39;collection&#39;) implies entry.all(resource.exists() and request.empty() and response.empty())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3b" />
                <severity value="error" />
                <human value="For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH" />
                <expression value="type = &#39;history&#39; implies entry.all(request.exists() and response.exists() and ((request.method in (&#39;POST&#39; | &#39;PATCH&#39; | &#39;PUT&#39;)) = resource.exists()))" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3c" />
                <severity value="error" />
                <human value="For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH" />
                <expression value="type in (&#39;transaction&#39; | &#39;batch&#39;) implies entry.all(request.method.exists() and ((request.method in (&#39;POST&#39; | &#39;PATCH&#39; | &#39;PUT&#39;)) = resource.exists()))" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3d" />
                <severity value="error" />
                <human value="For collections of type transaction-response or batch-response, all entries must contain response elements" />
                <expression value="type in (&#39;transaction-response&#39; | &#39;batch-response&#39;) implies entry.all(response.exists())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="Entity. Role, or Act,N/A" />
            </mapping>
            <mapping>
                <identity value="w5" />
                <map value="infrastructure.structure" />
            </mapping>
            <mapping>
                <identity value="v2" />
                <map value="N/A" />
            </mapping>
            <mapping>
                <identity value="cda" />
                <map value="ClinicalDocument, if bundle.type = document" />
            </mapping>
        </element>
        <element id="Bundle.id">
            <path value="Bundle.id" />
            <short value="Logical id of this artifact" />
            <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
            <comment value="Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Resource.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="id" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.meta">
            <path value="Bundle.meta" />
            <short value="Metadata about the resource" />
            <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Resource.meta" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Meta" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.implicitRules">
            <path value="Bundle.implicitRules" />
            <short value="A set of rules under which this content was created" />
            <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." />
            <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Resource.implicitRules" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="uri" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="true" />
            <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.language">
            <path value="Bundle.language" />
            <short value="Language of the resource content" />
            <definition value="The base language in which the resource is written." />
            <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Resource.language" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="code" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="false" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="Language" />
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
                    <valueBoolean value="true" />
                </extension>
                <strength value="required" />
                <description value="IETF language tag for a human language" />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages|5.0.0" />
                <additional>
                    <purpose value="starter" />
                    <valueSet value="http://hl7.org/fhir/ValueSet/languages" />
                </additional>
            </binding>
        </element>
        <element id="Bundle.identifier">
            <path value="Bundle.identifier" />
            <short value="Persistent identifier for the bundle" />
            <definition value="A persistent identifier for the bundle that won&#39;t change as a bundle is copied from server to server." />
            <comment value="Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents  the .identifier SHALL be populated such that the .identifier is globally unique." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.identifier" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Identifier" />
            </type>
            <condition value="bdl-9" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <mapping>
                <identity value="w5" />
                <map value="FiveWs.identifier" />
            </mapping>
            <mapping>
                <identity value="cda" />
                <map value="ClinicalDocument.id" />
            </mapping>
        </element>
        <element id="Bundle.type">
            <path value="Bundle.type" />
            <short value="document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification" />
            <definition value="Indicates the purpose of this bundle - how it is intended to be used." />
            <comment value="It&#39;s possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Bundle.type" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <code value="code" />
            </type>
            <condition value="bdl-1" />
            <condition value="bdl-2" />
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-3c" />
            <condition value="bdl-3d" />
            <condition value="bdl-7" />
            <condition value="bdl-9" />
            <condition value="bdl-10" />
            <condition value="bdl-11" />
            <condition value="bdl-12" />
            <condition value="bdl-13" />
            <condition value="bdl-14" />
            <condition value="bdl-15" />
            <condition value="bdl-17" />
            <condition value="bdl-18" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="BundleType" />
                </extension>
                <strength value="required" />
                <description value="Indicates the purpose of a bundle - how it is intended to be used." />
                <valueSet value="http://hl7.org/fhir/ValueSet/bundle-type|5.0.0" />
            </binding>
            <mapping>
                <identity value="w5" />
                <map value="FiveWs.class" />
            </mapping>
        </element>
        <element id="Bundle.timestamp">
            <path value="Bundle.timestamp" />
            <short value="When the bundle was assembled" />
            <definition value="The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle." />
            <comment value="For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.  \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.timestamp" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="instant" />
            </type>
            <condition value="bdl-10" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <mapping>
                <identity value="w5" />
                <map value="FiveWs.init" />
            </mapping>
            <mapping>
                <identity value="cda" />
                <map value="ClinicalDocument.effectiveTime" />
            </mapping>
        </element>
        <element id="Bundle.total">
            <path value="Bundle.total" />
            <short value="If search, the total number of matches" />
            <definition value="If a set of search matches, this is the (potentially estimated) total number of entries of type &#39;match&#39; across all pages in the search.  It does not include search.mode = &#39;include&#39; or &#39;outcome&#39; entries and it does not provide a count of the number of entries in the Bundle." />
            <comment value="Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.total" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="unsignedInt" />
            </type>
            <condition value="bdl-1" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.link">
            <path value="Bundle.link" />
            <short value="Links related to this Bundle" />
            <definition value="A series of links that provide context to this bundle." />
            <comment value="Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.  The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners." />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Bundle.link" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-18" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.link.id">
            <path value="Bundle.link.id" />
            <representation value="xmlAttr" />
            <short value="Unique id for inter-element referencing" />
            <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="string" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <condition value="ele-1" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.link.extension">
            <path value="Bundle.link.extension" />
            <short value="Additional content defined by implementations" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <alias value="extensions" />
            <alias value="user content" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.link.modifierExtension">
            <path value="Bundle.link.modifierExtension" />
            <short value="Extensions that cannot be ignored even if unrecognized" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element&#39;s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
            <alias value="extensions" />
            <alias value="user content" />
            <alias value="modifiers" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="BackboneElement.modifierExtension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="true" />
            <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
            <isSummary value="true" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Bundle.link.relation">
            <path value="Bundle.link.relation" />
            <short value="See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1" />
            <definition value="A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Bundle.link.relation" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <code value="code" />
            </type>
            <condition value="bdl-18" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0" />
            </binding>
        </element>
        <element id="Bundle.link.url">
            <path value="Bundle.link.url" />
            <short value="Reference details for the link" />
            <definition value="The reference details for the link." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Bundle.link.url" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <code value="uri" />
            </type>
            <condition value="bdl-18" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry">
            <path value="Bundle.entry" />
            <short value="Entry in the bundle - will have a resource or information" />
            <definition value="An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only)." />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Bundle.entry" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="BackboneElement" />
            </type>
            <orderMeaning value="For bundles of type &#39;document&#39; and &#39;message&#39;, the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type" />
            <constraint>
                <key value="bdl-5" />
                <severity value="error" />
                <human value="must be a resource unless there&#39;s a request or response" />
                <expression value="resource.exists() or request.exists() or response.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-8" />
                <severity value="error" />
                <human value="fullUrl cannot be a version specific reference" />
                <expression value="fullUrl.exists() implies fullUrl.contains(&#39;/_history/&#39;).not()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.id">
            <path value="Bundle.entry.id" />
            <representation value="xmlAttr" />
            <short value="Unique id for inter-element referencing" />
            <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="string" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <condition value="ele-1" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.extension">
            <path value="Bundle.entry.extension" />
            <short value="Additional content defined by implementations" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <alias value="extensions" />
            <alias value="user content" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.modifierExtension">
            <path value="Bundle.entry.modifierExtension" />
            <short value="Extensions that cannot be ignored even if unrecognized" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element&#39;s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
            <alias value="extensions" />
            <alias value="user content" />
            <alias value="modifiers" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="BackboneElement.modifierExtension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="true" />
            <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
            <isSummary value="true" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Bundle.entry.link">
            <path value="Bundle.entry.link" />
            <short value="Links related to this entry" />
            <definition value="A series of links that provide context to this entry." />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Bundle.entry.link" />
                <min value="0" />
                <max value="*" />
            </base>
            <contentReference value="#Bundle.link" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.fullUrl">
            <path value="Bundle.entry.fullUrl" />
            <short value="URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)" />
            <definition value="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: \n* invoking a create\n* invoking or responding to an operation where the body is not a single identified resource\n* invoking or returning the results of a search or history operation." />
            <comment value="fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the &#39;id&#39; portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it&#39;s an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL)." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.fullUrl" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="uri" />
            </type>
            <condition value="bdl-7" />
            <condition value="bdl-15" />
            <condition value="bdl-8" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.resource">
            <path value="Bundle.entry.resource" />
            <short value="A resource in the bundle" />
            <definition value="The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.resource" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Resource" />
            </type>
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-3c" />
            <condition value="bdl-7" />
            <condition value="bdl-11" />
            <condition value="bdl-12" />
            <condition value="bdl-13" />
            <condition value="bdl-5" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.search">
            <path value="Bundle.entry.search" />
            <short value="Search related information" />
            <definition value="Information about the search process that lead to the creation of this entry." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.search" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-2" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.search.id">
            <path value="Bundle.entry.search.id" />
            <representation value="xmlAttr" />
            <short value="Unique id for inter-element referencing" />
            <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="string" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <condition value="ele-1" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.search.extension">
            <path value="Bundle.entry.search.extension" />
            <short value="Additional content defined by implementations" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <alias value="extensions" />
            <alias value="user content" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.search.modifierExtension">
            <path value="Bundle.entry.search.modifierExtension" />
            <short value="Extensions that cannot be ignored even if unrecognized" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element&#39;s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
            <alias value="extensions" />
            <alias value="user content" />
            <alias value="modifiers" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="BackboneElement.modifierExtension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="true" />
            <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
            <isSummary value="true" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Bundle.entry.search.mode">
            <path value="Bundle.entry.search.mode" />
            <short value="match | include - why this is in the result set" />
            <definition value="Why this entry is in the result set - whether it&#39;s included as a match or because of an _include requirement, or to convey information or warning information about the search process." />
            <comment value="There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, &#39;match&#39; takes precedence." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.search.mode" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="code" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="SearchEntryMode" />
                </extension>
                <strength value="required" />
                <description value="Why an entry is in the result set - whether it&#39;s included as a match or because of an _include requirement, or to convey information or warning information about the search process." />
                <valueSet value="http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0" />
            </binding>
        </element>
        <element id="Bundle.entry.search.score">
            <path value="Bundle.entry.search.score" />
            <short value="Search ranking (between 0 and 1)" />
            <definition value="When searching, the server&#39;s search ranking score for the entry." />
            <comment value="Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.search.score" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="decimal" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request">
            <path value="Bundle.entry.request" />
            <short value="Additional execution information (transaction/batch/history)" />
            <definition value="Additional information about how this entry should be processed as part of a transaction or batch.  For history, it shows how the entry was processed to create the version contained in the entry." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.request" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-5" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.id">
            <path value="Bundle.entry.request.id" />
            <representation value="xmlAttr" />
            <short value="Unique id for inter-element referencing" />
            <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="string" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <condition value="ele-1" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.request.extension">
            <path value="Bundle.entry.request.extension" />
            <short value="Additional content defined by implementations" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <alias value="extensions" />
            <alias value="user content" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.request.modifierExtension">
            <path value="Bundle.entry.request.modifierExtension" />
            <short value="Extensions that cannot be ignored even if unrecognized" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element&#39;s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
            <alias value="extensions" />
            <alias value="user content" />
            <alias value="modifiers" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="BackboneElement.modifierExtension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="true" />
            <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
            <isSummary value="true" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Bundle.entry.request.method">
            <path value="Bundle.entry.request.method" />
            <short value="GET | HEAD | POST | PUT | DELETE | PATCH" />
            <definition value="In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.request.method" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <code value="code" />
            </type>
            <condition value="bdl-3b" />
            <condition value="bdl-3c" />
            <condition value="bdl-14" />
            <condition value="bdl-15" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="HTTPVerb" />
                </extension>
                <strength value="required" />
                <description value="HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details." />
                <valueSet value="http://hl7.org/fhir/ValueSet/http-verb|5.0.0" />
            </binding>
        </element>
        <element id="Bundle.entry.request.url">
            <path value="Bundle.entry.request.url" />
            <short value="URL for HTTP equivalent of this entry" />
            <definition value="The URL for this entry, relative to the root (the address to which the request is posted)." />
            <comment value="E.g. for a Patient Create, the method would be &quot;POST&quot; and the URL would be &quot;Patient&quot;. For a Patient Update, the method would be PUT and the URL would be &quot;Patient/[id]&quot;." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.request.url" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <code value="uri" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifNoneMatch">
            <path value="Bundle.entry.request.ifNoneMatch" />
            <short value="For managing cache validation" />
            <definition value="If the ETag values match, return a 304 Not Modified status. See the API documentation for [&quot;Conditional Read&quot;](http.html#cread)." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.request.ifNoneMatch" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="string" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifModifiedSince">
            <path value="Bundle.entry.request.ifModifiedSince" />
            <short value="For managing cache currency" />
            <definition value="Only perform the operation if the last updated date matches. See the API documentation for [&quot;Conditional Read&quot;](http.html#cread)." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.request.ifModifiedSince" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="instant" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifMatch">
            <path value="Bundle.entry.request.ifMatch" />
            <short value="For managing update contention" />
            <definition value="Only perform the operation if the Etag value matches. For more information, see the API section [&quot;Managing Resource Contention&quot;](http.html#concurrency)." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.request.ifMatch" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="string" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifNoneExist">
            <path value="Bundle.entry.request.ifNoneExist" />
            <short value="For conditional creates" />
            <definition value="Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [&quot;Conditional Create&quot;](http.html#ccreate). This is just the query portion of the URL - what follows the &quot;?&quot; (not including the &quot;?&quot;)." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.request.ifNoneExist" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="string" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response">
            <path value="Bundle.entry.response" />
            <short value="Results of execution (transaction/batch/history)" />
            <definition value="Indicates the results of processing the corresponding &#39;request&#39; entry in the batch or transaction being responded to or what the results of an operation where when returning history." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.response" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-3d" />
            <condition value="bdl-5" />
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.id">
            <path value="Bundle.entry.response.id" />
            <representation value="xmlAttr" />
            <short value="Unique id for inter-element referencing" />
            <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Element.id" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
                    <valueUrl value="string" />
                </extension>
                <code value="http://hl7.org/fhirpath/System.String" />
            </type>
            <condition value="ele-1" />
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.response.extension">
            <path value="Bundle.entry.response.extension" />
            <short value="Additional content defined by implementations" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <alias value="extensions" />
            <alias value="user content" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="Element.extension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="false" />
            <isSummary value="false" />
            <mapping>
                <identity value="rim" />
                <map value="n/a" />
            </mapping>
        </element>
        <element id="Bundle.entry.response.modifierExtension">
            <path value="Bundle.entry.response.modifierExtension" />
            <short value="Extensions that cannot be ignored even if unrecognized" />
            <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element&#39;s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
            <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
            <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
            <alias value="extensions" />
            <alias value="user content" />
            <alias value="modifiers" />
            <min value="0" />
            <max value="*" />
            <base>
                <path value="BackboneElement.modifierExtension" />
                <min value="0" />
                <max value="*" />
            </base>
            <type>
                <code value="Extension" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <constraint>
                <key value="ext-1" />
                <severity value="error" />
                <human value="Must have either extensions or value[x], not both" />
                <expression value="extension.exists() != value.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
            </constraint>
            <isModifier value="true" />
            <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
            <isSummary value="true" />
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
        </element>
        <element id="Bundle.entry.response.status">
            <path value="Bundle.entry.response.status" />
            <short value="Status response code (text optional)" />
            <definition value="The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code." />
            <min value="1" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.response.status" />
                <min value="1" />
                <max value="1" />
            </base>
            <type>
                <code value="string" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.location">
            <path value="Bundle.entry.response.location" />
            <short value="The location (if the operation returns a location)" />
            <definition value="The location header created by processing this operation, populated if the operation returns a location." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.response.location" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="uri" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.etag">
            <path value="Bundle.entry.response.etag" />
            <short value="The Etag for the resource (if relevant)" />
            <definition value="The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency))." />
            <comment value="Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.response.etag" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="string" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.lastModified">
            <path value="Bundle.entry.response.lastModified" />
            <short value="Server&#39;s date time modified" />
            <definition value="The date/time that the resource was modified on the server." />
            <comment value="This has to match the same time in the meta header (meta.lastUpdated) if a resource is included." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.response.lastModified" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="instant" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.outcome">
            <path value="Bundle.entry.response.outcome" />
            <short value="OperationOutcome with hints and warnings (for batch/transaction)" />
            <definition value="An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction." />
            <comment value="For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.entry.response.outcome" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Resource" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.signature">
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
                <valueCode value="trial-use" />
            </extension>
            <path value="Bundle.signature" />
            <short value="Digital Signature" />
            <definition value="Digital Signature - base64 encoded. XML-DSig or a JWS." />
            <comment value="The signature could be created by the &quot;author&quot; of the bundle or by the originating device.   Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific." />
            <requirements value="A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.signature" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Signature" />
            </type>
            <constraint>
                <key value="ele-1" />
                <severity value="error" />
                <human value="All FHIR elements must have a @value or children" />
                <expression value="hasValue() or (children().count() &gt; id.count())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Element" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.issues">
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
                <valueCode value="trial-use" />
            </extension>
            <path value="Bundle.issues" />
            <short value="Issues with the Bundle" />
            <definition value="Captures issues and warnings that relate to the construction of the Bundle and the content within it." />
            <comment value="Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry.  If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle." />
            <min value="0" />
            <max value="1" />
            <base>
                <path value="Bundle.issues" />
                <min value="0" />
                <max value="1" />
            </base>
            <type>
                <code value="Resource" />
                <profile value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" />
            </type>
            <condition value="bdl-16" />
            <condition value="bdl-17" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
    </snapshot>
    <differential>
        <element id="Bundle">
            <path value="Bundle" />
            <short value="Contains a collection of resources" />
            <definition value="A container for a collection of resources." />
            <min value="0" />
            <max value="*" />
            <constraint>
                <key value="bdl-7" />
                <severity value="error" />
                <human value="FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)" />
                <expression value="(type = &#39;history&#39;) or entry.where(fullUrl.exists()).select(fullUrl&amp;iif(resource.meta.versionId.exists(), resource.meta.versionId, &#39;&#39;)).isDistinct()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-9" />
                <severity value="error" />
                <human value="A document must have an identifier with a system and a value" />
                <expression value="type = &#39;document&#39; implies (identifier.system.exists() and identifier.value.exists())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-17" />
                <severity value="error" />
                <human value="Use and meaning of issues for documents has not been validated because the content will not be rendered in the document." />
                <expression value="type = &#39;document&#39; implies issues.empty()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-16" />
                <severity value="error" />
                <human value="Issue.severity for all issues within the OperationOutcome must be either &#39;information&#39; or &#39;warning&#39;." />
                <expression value="issues.exists() implies (issues.issue.severity = &#39;information&#39; or issues.issue.severity = &#39;warning&#39;)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-18" />
                <severity value="error" />
                <human value="Self link is required for searchsets." />
                <expression value="type = &#39;searchset&#39; implies link.where(relation = &#39;self&#39; and url.exists()).exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-13" />
                <severity value="error" />
                <human value="A subscription-notification must have a SubscriptionStatus as the first resource" />
                <expression value="type = &#39;subscription-notification&#39; implies entry.first().resource.is(SubscriptionStatus)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-12" />
                <severity value="error" />
                <human value="A message must have a MessageHeader as the first resource" />
                <expression value="type = &#39;message&#39; implies entry.first().resource.is(MessageHeader)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-15" />
                <severity value="error" />
                <human value="Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated" />
                <expression value="type=&#39;transaction&#39; or type=&#39;transaction-response&#39; or type=&#39;batch&#39; or type=&#39;batch-response&#39; or entry.all(fullUrl.exists() or request.method=&#39;POST&#39;)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-14" />
                <severity value="error" />
                <human value="entry.request.method PATCH not allowed for history" />
                <expression value="type = &#39;history&#39; implies entry.request.method != &#39;PATCH&#39;" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-11" />
                <severity value="error" />
                <human value="A document must have a Composition as the first resource" />
                <expression value="type = &#39;document&#39; implies entry.first().resource.is(Composition)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-10" />
                <severity value="error" />
                <human value="A document must have a date" />
                <expression value="type = &#39;document&#39; implies (timestamp.hasValue())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3d" />
                <severity value="error" />
                <human value="For collections of type transaction-response or batch-response, all entries must contain response elements" />
                <expression value="type in (&#39;transaction-response&#39; | &#39;batch-response&#39;) implies entry.all(response.exists())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-1" />
                <severity value="error" />
                <human value="total only when a search or history" />
                <expression value="total.empty() or (type = &#39;searchset&#39;) or (type = &#39;history&#39;)" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-2" />
                <severity value="error" />
                <human value="entry.search only when a search" />
                <expression value="(type = &#39;searchset&#39;) or entry.search.empty()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3a" />
                <severity value="error" />
                <human value="For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements" />
                <expression value="type in (&#39;document&#39; | &#39;message&#39; | &#39;searchset&#39; | &#39;collection&#39;) implies entry.all(resource.exists() and request.empty() and response.empty())" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3c" />
                <severity value="error" />
                <human value="For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH" />
                <expression value="type in (&#39;transaction&#39; | &#39;batch&#39;) implies entry.all(request.method.exists() and ((request.method in (&#39;POST&#39; | &#39;PATCH&#39; | &#39;PUT&#39;)) = resource.exists()))" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-3b" />
                <severity value="error" />
                <human value="For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH" />
                <expression value="type = &#39;history&#39; implies entry.all(request.exists() and response.exists() and ((request.method in (&#39;POST&#39; | &#39;PATCH&#39; | &#39;PUT&#39;)) = resource.exists()))" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <mapping>
                <identity value="w5" />
                <map value="infrastructure.structure" />
            </mapping>
            <mapping>
                <identity value="v2" />
                <map value="N/A" />
            </mapping>
            <mapping>
                <identity value="rim" />
                <map value="N/A" />
            </mapping>
            <mapping>
                <identity value="cda" />
                <map value="ClinicalDocument, if bundle.type = document" />
            </mapping>
        </element>
        <element id="Bundle.identifier">
            <path value="Bundle.identifier" />
            <short value="Persistent identifier for the bundle" />
            <definition value="A persistent identifier for the bundle that won&#39;t change as a bundle is copied from server to server." />
            <comment value="Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents  the .identifier SHALL be populated such that the .identifier is globally unique." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Identifier" />
            </type>
            <condition value="bdl-9" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <mapping>
                <identity value="w5" />
                <map value="FiveWs.identifier" />
            </mapping>
            <mapping>
                <identity value="cda" />
                <map value="ClinicalDocument.id" />
            </mapping>
        </element>
        <element id="Bundle.type">
            <path value="Bundle.type" />
            <short value="document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification" />
            <definition value="Indicates the purpose of this bundle - how it is intended to be used." />
            <comment value="It&#39;s possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types." />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="code" />
            </type>
            <condition value="bdl-1" />
            <condition value="bdl-2" />
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-3c" />
            <condition value="bdl-3d" />
            <condition value="bdl-7" />
            <condition value="bdl-9" />
            <condition value="bdl-10" />
            <condition value="bdl-11" />
            <condition value="bdl-12" />
            <condition value="bdl-13" />
            <condition value="bdl-14" />
            <condition value="bdl-15" />
            <condition value="bdl-17" />
            <condition value="bdl-18" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="BundleType" />
                </extension>
                <strength value="required" />
                <description value="Indicates the purpose of a bundle - how it is intended to be used." />
                <valueSet value="http://hl7.org/fhir/ValueSet/bundle-type|5.0.0" />
            </binding>
            <mapping>
                <identity value="w5" />
                <map value="FiveWs.class" />
            </mapping>
        </element>
        <element id="Bundle.timestamp">
            <path value="Bundle.timestamp" />
            <short value="When the bundle was assembled" />
            <definition value="The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle." />
            <comment value="For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.  \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="instant" />
            </type>
            <condition value="bdl-10" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <mapping>
                <identity value="w5" />
                <map value="FiveWs.init" />
            </mapping>
            <mapping>
                <identity value="cda" />
                <map value="ClinicalDocument.effectiveTime" />
            </mapping>
        </element>
        <element id="Bundle.total">
            <path value="Bundle.total" />
            <short value="If search, the total number of matches" />
            <definition value="If a set of search matches, this is the (potentially estimated) total number of entries of type &#39;match&#39; across all pages in the search.  It does not include search.mode = &#39;include&#39; or &#39;outcome&#39; entries and it does not provide a count of the number of entries in the Bundle." />
            <comment value="Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="unsignedInt" />
            </type>
            <condition value="bdl-1" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.link">
            <path value="Bundle.link" />
            <short value="Links related to this Bundle" />
            <definition value="A series of links that provide context to this bundle." />
            <comment value="Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.  The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners." />
            <min value="0" />
            <max value="*" />
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-18" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.link.relation">
            <path value="Bundle.link.relation" />
            <short value="See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1" />
            <definition value="A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)." />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="code" />
            </type>
            <condition value="bdl-18" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0" />
            </binding>
        </element>
        <element id="Bundle.link.url">
            <path value="Bundle.link.url" />
            <short value="Reference details for the link" />
            <definition value="The reference details for the link." />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="uri" />
            </type>
            <condition value="bdl-18" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry">
            <path value="Bundle.entry" />
            <short value="Entry in the bundle - will have a resource or information" />
            <definition value="An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only)." />
            <min value="0" />
            <max value="*" />
            <type>
                <code value="BackboneElement" />
            </type>
            <orderMeaning value="For bundles of type &#39;document&#39; and &#39;message&#39;, the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type" />
            <constraint>
                <key value="bdl-8" />
                <severity value="error" />
                <human value="fullUrl cannot be a version specific reference" />
                <expression value="fullUrl.exists() implies fullUrl.contains(&#39;/_history/&#39;).not()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <constraint>
                <key value="bdl-5" />
                <severity value="error" />
                <human value="must be a resource unless there&#39;s a request or response" />
                <expression value="resource.exists() or request.exists() or response.exists()" />
                <source value="http://hl7.org/fhir/StructureDefinition/Bundle" />
            </constraint>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.link">
            <path value="Bundle.entry.link" />
            <short value="Links related to this entry" />
            <definition value="A series of links that provide context to this entry." />
            <min value="0" />
            <max value="*" />
            <contentReference value="#Bundle.link" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.fullUrl">
            <path value="Bundle.entry.fullUrl" />
            <short value="URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)" />
            <definition value="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: \n* invoking a create\n* invoking or responding to an operation where the body is not a single identified resource\n* invoking or returning the results of a search or history operation." />
            <comment value="fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the &#39;id&#39; portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it&#39;s an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL)." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="uri" />
            </type>
            <condition value="bdl-7" />
            <condition value="bdl-15" />
            <condition value="bdl-8" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.resource">
            <path value="Bundle.entry.resource" />
            <short value="A resource in the bundle" />
            <definition value="The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Resource" />
            </type>
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-3c" />
            <condition value="bdl-7" />
            <condition value="bdl-11" />
            <condition value="bdl-12" />
            <condition value="bdl-13" />
            <condition value="bdl-5" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.search">
            <path value="Bundle.entry.search" />
            <short value="Search related information" />
            <definition value="Information about the search process that lead to the creation of this entry." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-2" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.search.mode">
            <path value="Bundle.entry.search.mode" />
            <short value="match | include - why this is in the result set" />
            <definition value="Why this entry is in the result set - whether it&#39;s included as a match or because of an _include requirement, or to convey information or warning information about the search process." />
            <comment value="There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, &#39;match&#39; takes precedence." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="code" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="SearchEntryMode" />
                </extension>
                <strength value="required" />
                <description value="Why an entry is in the result set - whether it&#39;s included as a match or because of an _include requirement, or to convey information or warning information about the search process." />
                <valueSet value="http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0" />
            </binding>
        </element>
        <element id="Bundle.entry.search.score">
            <path value="Bundle.entry.search.score" />
            <short value="Search ranking (between 0 and 1)" />
            <definition value="When searching, the server&#39;s search ranking score for the entry." />
            <comment value="Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="decimal" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request">
            <path value="Bundle.entry.request" />
            <short value="Additional execution information (transaction/batch/history)" />
            <definition value="Additional information about how this entry should be processed as part of a transaction or batch.  For history, it shows how the entry was processed to create the version contained in the entry." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-5" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.method">
            <path value="Bundle.entry.request.method" />
            <short value="GET | HEAD | POST | PUT | DELETE | PATCH" />
            <definition value="In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred." />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="code" />
            </type>
            <condition value="bdl-3b" />
            <condition value="bdl-3c" />
            <condition value="bdl-14" />
            <condition value="bdl-15" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="HTTPVerb" />
                </extension>
                <strength value="required" />
                <description value="HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details." />
                <valueSet value="http://hl7.org/fhir/ValueSet/http-verb|5.0.0" />
            </binding>
        </element>
        <element id="Bundle.entry.request.url">
            <path value="Bundle.entry.request.url" />
            <short value="URL for HTTP equivalent of this entry" />
            <definition value="The URL for this entry, relative to the root (the address to which the request is posted)." />
            <comment value="E.g. for a Patient Create, the method would be &quot;POST&quot; and the URL would be &quot;Patient&quot;. For a Patient Update, the method would be PUT and the URL would be &quot;Patient/[id]&quot;." />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="uri" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifNoneMatch">
            <path value="Bundle.entry.request.ifNoneMatch" />
            <short value="For managing cache validation" />
            <definition value="If the ETag values match, return a 304 Not Modified status. See the API documentation for [&quot;Conditional Read&quot;](http.html#cread)." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="string" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifModifiedSince">
            <path value="Bundle.entry.request.ifModifiedSince" />
            <short value="For managing cache currency" />
            <definition value="Only perform the operation if the last updated date matches. See the API documentation for [&quot;Conditional Read&quot;](http.html#cread)." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="instant" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifMatch">
            <path value="Bundle.entry.request.ifMatch" />
            <short value="For managing update contention" />
            <definition value="Only perform the operation if the Etag value matches. For more information, see the API section [&quot;Managing Resource Contention&quot;](http.html#concurrency)." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="string" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.request.ifNoneExist">
            <path value="Bundle.entry.request.ifNoneExist" />
            <short value="For conditional creates" />
            <definition value="Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [&quot;Conditional Create&quot;](http.html#ccreate). This is just the query portion of the URL - what follows the &quot;?&quot; (not including the &quot;?&quot;)." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="string" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response">
            <path value="Bundle.entry.response" />
            <short value="Results of execution (transaction/batch/history)" />
            <definition value="Indicates the results of processing the corresponding &#39;request&#39; entry in the batch or transaction being responded to or what the results of an operation where when returning history." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="BackboneElement" />
            </type>
            <condition value="bdl-3a" />
            <condition value="bdl-3b" />
            <condition value="bdl-3d" />
            <condition value="bdl-5" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.status">
            <path value="Bundle.entry.response.status" />
            <short value="Status response code (text optional)" />
            <definition value="The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code." />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="string" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.location">
            <path value="Bundle.entry.response.location" />
            <short value="The location (if the operation returns a location)" />
            <definition value="The location header created by processing this operation, populated if the operation returns a location." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="uri" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.etag">
            <path value="Bundle.entry.response.etag" />
            <short value="The Etag for the resource (if relevant)" />
            <definition value="The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency))." />
            <comment value="Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="string" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.lastModified">
            <path value="Bundle.entry.response.lastModified" />
            <short value="Server&#39;s date time modified" />
            <definition value="The date/time that the resource was modified on the server." />
            <comment value="This has to match the same time in the meta header (meta.lastUpdated) if a resource is included." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="instant" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.entry.response.outcome">
            <path value="Bundle.entry.response.outcome" />
            <short value="OperationOutcome with hints and warnings (for batch/transaction)" />
            <definition value="An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction." />
            <comment value="For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Resource" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.signature">
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
                <valueCode value="trial-use" />
            </extension>
            <path value="Bundle.signature" />
            <short value="Digital Signature" />
            <definition value="Digital Signature - base64 encoded. XML-DSig or a JWS." />
            <comment value="The signature could be created by the &quot;author&quot; of the bundle or by the originating device.   Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific." />
            <requirements value="A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Signature" />
            </type>
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
        <element id="Bundle.issues">
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
                <valueCode value="trial-use" />
            </extension>
            <path value="Bundle.issues" />
            <short value="Issues with the Bundle" />
            <definition value="Captures issues and warnings that relate to the construction of the Bundle and the content within it." />
            <comment value="Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry.  If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Resource" />
                <profile value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" />
            </type>
            <condition value="bdl-16" />
            <condition value="bdl-17" />
            <mustSupport value="false" />
            <isModifier value="false" />
            <isSummary value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "Bundle",
    "meta": {
        "lastUpdated": "2023-03-26T15:21:02.749+11:00"
    },
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
            "valueString": "Foundation.Other"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
            "valueCode": "not-classified"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        }
    ],
    "url": "http://hl7.org/fhir/StructureDefinition/Bundle",
    "version": "5.0.0",
    "name": "Bundle",
    "status": "active",
    "experimental": false,
    "date": "2023-03-26T15:21:02+11:00",
    "publisher": "Health Level Seven International (FHIR Infrastructure)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        },
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
                }
            ]
        }
    ],
    "description": "A container for a collection of resources.",
    "jurisdiction":  [
        {
            "coding":  [
                {
                    "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
                    "code": "001",
                    "display": "World"
                }
            ]
        }
    ],
    "fhirVersion": "5.0.0",
    "mapping":  [
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 V2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "cda",
            "uri": "http://hl7.org/v3/cda",
            "name": "CDA (R2)"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Bundle",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Resource",
    "derivation": "specialization",
    "snapshot": {
        "element":  [
            {
                "id": "Bundle",
                "path": "Bundle",
                "short": "Contains a collection of resources",
                "definition": "A container for a collection of resources.",
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Bundle",
                    "min": 0,
                    "max": "*"
                },
                "constraint":  [
                    {
                        "key": "bdl-1",
                        "severity": "error",
                        "human": "total only when a search or history",
                        "expression": "total.empty() or (type = 'searchset') or (type = 'history')",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-2",
                        "severity": "error",
                        "human": "entry.search only when a search",
                        "expression": "(type = 'searchset') or entry.search.empty()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-7",
                        "severity": "error",
                        "human": "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)",
                        "expression": "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-9",
                        "severity": "error",
                        "human": "A document must have an identifier with a system and a value",
                        "expression": "type = 'document' implies (identifier.system.exists() and identifier.value.exists())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-10",
                        "severity": "error",
                        "human": "A document must have a date",
                        "expression": "type = 'document' implies (timestamp.hasValue())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-11",
                        "severity": "error",
                        "human": "A document must have a Composition as the first resource",
                        "expression": "type = 'document' implies entry.first().resource.is(Composition)",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-12",
                        "severity": "error",
                        "human": "A message must have a MessageHeader as the first resource",
                        "expression": "type = 'message' implies entry.first().resource.is(MessageHeader)",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-13",
                        "severity": "error",
                        "human": "A subscription-notification must have a SubscriptionStatus as the first resource",
                        "expression": "type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-14",
                        "severity": "error",
                        "human": "entry.request.method PATCH not allowed for history",
                        "expression": "type = 'history' implies entry.request.method != 'PATCH'",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-15",
                        "severity": "error",
                        "human": "Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated",
                        "expression": "type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-16",
                        "severity": "error",
                        "human": "Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.",
                        "expression": "issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-17",
                        "severity": "error",
                        "human": "Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.",
                        "expression": "type = 'document' implies issues.empty()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-18",
                        "severity": "error",
                        "human": "Self link is required for searchsets.",
                        "expression": "type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3a",
                        "severity": "error",
                        "human": "For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements",
                        "expression": "type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3b",
                        "severity": "error",
                        "human": "For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH",
                        "expression": "type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3c",
                        "severity": "error",
                        "human": "For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH",
                        "expression": "type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3d",
                        "severity": "error",
                        "human": "For collections of type transaction-response or batch-response, all entries must contain response elements",
                        "expression": "type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "Entity. Role, or Act,N/A"
                    },
                    {
                        "identity": "w5",
                        "map": "infrastructure.structure"
                    },
                    {
                        "identity": "v2",
                        "map": "N/A"
                    },
                    {
                        "identity": "cda",
                        "map": "ClinicalDocument, if bundle.type = document"
                    }
                ]
            },
            {
                "id": "Bundle.id",
                "path": "Bundle.id",
                "short": "Logical id of this artifact",
                "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
                "comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Resource.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "id"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.meta",
                "path": "Bundle.meta",
                "short": "Metadata about the resource",
                "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Resource.meta",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Meta"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.implicitRules",
                "path": "Bundle.implicitRules",
                "short": "A set of rules under which this content was created",
                "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
                "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Resource.implicitRules",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": true,
                "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
                "isSummary": true
            },
            {
                "id": "Bundle.language",
                "path": "Bundle.language",
                "short": "Language of the resource content",
                "definition": "The base language in which the resource is written.",
                "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Resource.language",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": false,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "Language"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
                            "valueBoolean": true
                        }
                    ],
                    "strength": "required",
                    "description": "IETF language tag for a human language",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
                    "additional":  [
                        {
                            "purpose": "starter",
                            "valueSet": "http://hl7.org/fhir/ValueSet/languages"
                        }
                    ]
                }
            },
            {
                "id": "Bundle.identifier",
                "path": "Bundle.identifier",
                "short": "Persistent identifier for the bundle",
                "definition": "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.",
                "comment": "Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents  the .identifier SHALL be populated such that the .identifier is globally unique.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.identifier",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Identifier"
                    }
                ],
                "condition":  [
                    "bdl-9"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.identifier"
                    },
                    {
                        "identity": "cda",
                        "map": "ClinicalDocument.id"
                    }
                ]
            },
            {
                "id": "Bundle.type",
                "path": "Bundle.type",
                "short": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification",
                "definition": "Indicates the purpose of this bundle - how it is intended to be used.",
                "comment": "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Bundle.type",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "condition":  [
                    "bdl-1",
                    "bdl-2",
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-3c",
                    "bdl-3d",
                    "bdl-7",
                    "bdl-9",
                    "bdl-10",
                    "bdl-11",
                    "bdl-12",
                    "bdl-13",
                    "bdl-14",
                    "bdl-15",
                    "bdl-17",
                    "bdl-18"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "BundleType"
                        }
                    ],
                    "strength": "required",
                    "description": "Indicates the purpose of a bundle - how it is intended to be used.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/bundle-type|5.0.0"
                },
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.class"
                    }
                ]
            },
            {
                "id": "Bundle.timestamp",
                "path": "Bundle.timestamp",
                "short": "When the bundle was assembled",
                "definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
                "comment": "For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.  \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.timestamp",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "instant"
                    }
                ],
                "condition":  [
                    "bdl-10"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.init"
                    },
                    {
                        "identity": "cda",
                        "map": "ClinicalDocument.effectiveTime"
                    }
                ]
            },
            {
                "id": "Bundle.total",
                "path": "Bundle.total",
                "short": "If search, the total number of matches",
                "definition": "If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search.  It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.",
                "comment": "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.total",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "unsignedInt"
                    }
                ],
                "condition":  [
                    "bdl-1"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.link",
                "path": "Bundle.link",
                "short": "Links related to this Bundle",
                "definition": "A series of links that provide context to this bundle.",
                "comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.  The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.",
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Bundle.link",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-18"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.link.id",
                "path": "Bundle.link.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "Unique id for inter-element referencing",
                "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "string"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.link.extension",
                "path": "Bundle.link.extension",
                "short": "Additional content defined by implementations",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "alias":  [
                    "extensions",
                    "user content"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.link.modifierExtension",
                "path": "Bundle.link.modifierExtension",
                "short": "Extensions that cannot be ignored even if unrecognized",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
                "alias":  [
                    "extensions",
                    "user content",
                    "modifiers"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "BackboneElement.modifierExtension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": true,
                "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Bundle.link.relation",
                "path": "Bundle.link.relation",
                "short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
                "definition": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Bundle.link.relation",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "condition":  [
                    "bdl-18"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0"
                }
            },
            {
                "id": "Bundle.link.url",
                "path": "Bundle.link.url",
                "short": "Reference details for the link",
                "definition": "The reference details for the link.",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Bundle.link.url",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "condition":  [
                    "bdl-18"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry",
                "path": "Bundle.entry",
                "short": "Entry in the bundle - will have a resource or information",
                "definition": "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Bundle.entry",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "orderMeaning": "For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type",
                "constraint":  [
                    {
                        "key": "bdl-5",
                        "severity": "error",
                        "human": "must be a resource unless there's a request or response",
                        "expression": "resource.exists() or request.exists() or response.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-8",
                        "severity": "error",
                        "human": "fullUrl cannot be a version specific reference",
                        "expression": "fullUrl.exists() implies fullUrl.contains('/_history/').not()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.id",
                "path": "Bundle.entry.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "Unique id for inter-element referencing",
                "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "string"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.extension",
                "path": "Bundle.entry.extension",
                "short": "Additional content defined by implementations",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "alias":  [
                    "extensions",
                    "user content"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.modifierExtension",
                "path": "Bundle.entry.modifierExtension",
                "short": "Extensions that cannot be ignored even if unrecognized",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
                "alias":  [
                    "extensions",
                    "user content",
                    "modifiers"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "BackboneElement.modifierExtension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": true,
                "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Bundle.entry.link",
                "path": "Bundle.entry.link",
                "short": "Links related to this entry",
                "definition": "A series of links that provide context to this entry.",
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Bundle.entry.link",
                    "min": 0,
                    "max": "*"
                },
                "contentReference": "#Bundle.link",
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "short": "URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)",
                "definition": "The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: \n* invoking a create\n* invoking or responding to an operation where the body is not a single identified resource\n* invoking or returning the results of a search or history operation.",
                "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.fullUrl",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "condition":  [
                    "bdl-7",
                    "bdl-15",
                    "bdl-8"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.resource",
                "path": "Bundle.entry.resource",
                "short": "A resource in the bundle",
                "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.resource",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Resource"
                    }
                ],
                "condition":  [
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-3c",
                    "bdl-7",
                    "bdl-11",
                    "bdl-12",
                    "bdl-13",
                    "bdl-5"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.search",
                "path": "Bundle.entry.search",
                "short": "Search related information",
                "definition": "Information about the search process that lead to the creation of this entry.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.search",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-2"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.search.id",
                "path": "Bundle.entry.search.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "Unique id for inter-element referencing",
                "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "string"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.search.extension",
                "path": "Bundle.entry.search.extension",
                "short": "Additional content defined by implementations",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "alias":  [
                    "extensions",
                    "user content"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.search.modifierExtension",
                "path": "Bundle.entry.search.modifierExtension",
                "short": "Extensions that cannot be ignored even if unrecognized",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
                "alias":  [
                    "extensions",
                    "user content",
                    "modifiers"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "BackboneElement.modifierExtension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": true,
                "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Bundle.entry.search.mode",
                "path": "Bundle.entry.search.mode",
                "short": "match | include - why this is in the result set",
                "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
                "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.search.mode",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "SearchEntryMode"
                        }
                    ],
                    "strength": "required",
                    "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0"
                }
            },
            {
                "id": "Bundle.entry.search.score",
                "path": "Bundle.entry.search.score",
                "short": "Search ranking (between 0 and 1)",
                "definition": "When searching, the server's search ranking score for the entry.",
                "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.search.score",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "decimal"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request",
                "path": "Bundle.entry.request",
                "short": "Additional execution information (transaction/batch/history)",
                "definition": "Additional information about how this entry should be processed as part of a transaction or batch.  For history, it shows how the entry was processed to create the version contained in the entry.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.request",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-5"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.id",
                "path": "Bundle.entry.request.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "Unique id for inter-element referencing",
                "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "string"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.request.extension",
                "path": "Bundle.entry.request.extension",
                "short": "Additional content defined by implementations",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "alias":  [
                    "extensions",
                    "user content"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.request.modifierExtension",
                "path": "Bundle.entry.request.modifierExtension",
                "short": "Extensions that cannot be ignored even if unrecognized",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
                "alias":  [
                    "extensions",
                    "user content",
                    "modifiers"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "BackboneElement.modifierExtension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": true,
                "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Bundle.entry.request.method",
                "path": "Bundle.entry.request.method",
                "short": "GET | HEAD | POST | PUT | DELETE | PATCH",
                "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.request.method",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "condition":  [
                    "bdl-3b",
                    "bdl-3c",
                    "bdl-14",
                    "bdl-15"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "HTTPVerb"
                        }
                    ],
                    "strength": "required",
                    "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|5.0.0"
                }
            },
            {
                "id": "Bundle.entry.request.url",
                "path": "Bundle.entry.request.url",
                "short": "URL for HTTP equivalent of this entry",
                "definition": "The URL for this entry, relative to the root (the address to which the request is posted).",
                "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.request.url",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifNoneMatch",
                "path": "Bundle.entry.request.ifNoneMatch",
                "short": "For managing cache validation",
                "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.request.ifNoneMatch",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifModifiedSince",
                "path": "Bundle.entry.request.ifModifiedSince",
                "short": "For managing cache currency",
                "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.request.ifModifiedSince",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "instant"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifMatch",
                "path": "Bundle.entry.request.ifMatch",
                "short": "For managing update contention",
                "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.request.ifMatch",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifNoneExist",
                "path": "Bundle.entry.request.ifNoneExist",
                "short": "For conditional creates",
                "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.request.ifNoneExist",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response",
                "path": "Bundle.entry.response",
                "short": "Results of execution (transaction/batch/history)",
                "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.response",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-3d",
                    "bdl-5"
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.id",
                "path": "Bundle.entry.response.id",
                "representation":  [
                    "xmlAttr"
                ],
                "short": "Unique id for inter-element referencing",
                "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Element.id",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                                "valueUrl": "string"
                            }
                        ],
                        "code": "http://hl7.org/fhirpath/System.String"
                    }
                ],
                "condition":  [
                    "ele-1"
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.response.extension",
                "path": "Bundle.entry.response.extension",
                "short": "Additional content defined by implementations",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "alias":  [
                    "extensions",
                    "user content"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "Element.extension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": false,
                "isSummary": false,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "n/a"
                    }
                ]
            },
            {
                "id": "Bundle.entry.response.modifierExtension",
                "path": "Bundle.entry.response.modifierExtension",
                "short": "Extensions that cannot be ignored even if unrecognized",
                "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
                "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
                "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
                "alias":  [
                    "extensions",
                    "user content",
                    "modifiers"
                ],
                "min": 0,
                "max": "*",
                "base": {
                    "path": "BackboneElement.modifierExtension",
                    "min": 0,
                    "max": "*"
                },
                "type":  [
                    {
                        "code": "Extension"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    },
                    {
                        "key": "ext-1",
                        "severity": "error",
                        "human": "Must have either extensions or value[x], not both",
                        "expression": "extension.exists() != value.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Extension"
                    }
                ],
                "isModifier": true,
                "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "N/A"
                    }
                ]
            },
            {
                "id": "Bundle.entry.response.status",
                "path": "Bundle.entry.response.status",
                "short": "Status response code (text optional)",
                "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
                "min": 1,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.response.status",
                    "min": 1,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.location",
                "path": "Bundle.entry.response.location",
                "short": "The location (if the operation returns a location)",
                "definition": "The location header created by processing this operation, populated if the operation returns a location.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.response.location",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.etag",
                "path": "Bundle.entry.response.etag",
                "short": "The Etag for the resource (if relevant)",
                "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).",
                "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.response.etag",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.lastModified",
                "path": "Bundle.entry.response.lastModified",
                "short": "Server's date time modified",
                "definition": "The date/time that the resource was modified on the server.",
                "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.response.lastModified",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "instant"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.outcome",
                "path": "Bundle.entry.response.outcome",
                "short": "OperationOutcome with hints and warnings (for batch/transaction)",
                "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
                "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.entry.response.outcome",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Resource"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.signature",
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
                        "valueCode": "trial-use"
                    }
                ],
                "path": "Bundle.signature",
                "short": "Digital Signature",
                "definition": "Digital Signature - base64 encoded. XML-DSig or a JWS.",
                "comment": "The signature could be created by the \"author\" of the bundle or by the originating device.   Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.",
                "requirements": "A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.signature",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Signature"
                    }
                ],
                "constraint":  [
                    {
                        "key": "ele-1",
                        "severity": "error",
                        "human": "All FHIR elements must have a @value or children",
                        "expression": "hasValue() or (children().count() > id.count())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Element"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.issues",
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
                        "valueCode": "trial-use"
                    }
                ],
                "path": "Bundle.issues",
                "short": "Issues with the Bundle",
                "definition": "Captures issues and warnings that relate to the construction of the Bundle and the content within it.",
                "comment": "Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry.  If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.",
                "min": 0,
                "max": "1",
                "base": {
                    "path": "Bundle.issues",
                    "min": 0,
                    "max": "1"
                },
                "type":  [
                    {
                        "code": "Resource",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
                        ]
                    }
                ],
                "condition":  [
                    "bdl-16",
                    "bdl-17"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            }
        ]
    },
    "differential": {
        "element":  [
            {
                "id": "Bundle",
                "path": "Bundle",
                "short": "Contains a collection of resources",
                "definition": "A container for a collection of resources.",
                "min": 0,
                "max": "*",
                "constraint":  [
                    {
                        "key": "bdl-7",
                        "severity": "error",
                        "human": "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)",
                        "expression": "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-9",
                        "severity": "error",
                        "human": "A document must have an identifier with a system and a value",
                        "expression": "type = 'document' implies (identifier.system.exists() and identifier.value.exists())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-17",
                        "severity": "error",
                        "human": "Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.",
                        "expression": "type = 'document' implies issues.empty()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-16",
                        "severity": "error",
                        "human": "Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.",
                        "expression": "issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-18",
                        "severity": "error",
                        "human": "Self link is required for searchsets.",
                        "expression": "type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-13",
                        "severity": "error",
                        "human": "A subscription-notification must have a SubscriptionStatus as the first resource",
                        "expression": "type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-12",
                        "severity": "error",
                        "human": "A message must have a MessageHeader as the first resource",
                        "expression": "type = 'message' implies entry.first().resource.is(MessageHeader)",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-15",
                        "severity": "error",
                        "human": "Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated",
                        "expression": "type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-14",
                        "severity": "error",
                        "human": "entry.request.method PATCH not allowed for history",
                        "expression": "type = 'history' implies entry.request.method != 'PATCH'",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-11",
                        "severity": "error",
                        "human": "A document must have a Composition as the first resource",
                        "expression": "type = 'document' implies entry.first().resource.is(Composition)",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-10",
                        "severity": "error",
                        "human": "A document must have a date",
                        "expression": "type = 'document' implies (timestamp.hasValue())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3d",
                        "severity": "error",
                        "human": "For collections of type transaction-response or batch-response, all entries must contain response elements",
                        "expression": "type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-1",
                        "severity": "error",
                        "human": "total only when a search or history",
                        "expression": "total.empty() or (type = 'searchset') or (type = 'history')",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-2",
                        "severity": "error",
                        "human": "entry.search only when a search",
                        "expression": "(type = 'searchset') or entry.search.empty()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3a",
                        "severity": "error",
                        "human": "For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements",
                        "expression": "type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3c",
                        "severity": "error",
                        "human": "For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH",
                        "expression": "type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-3b",
                        "severity": "error",
                        "human": "For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH",
                        "expression": "type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "infrastructure.structure"
                    },
                    {
                        "identity": "v2",
                        "map": "N/A"
                    },
                    {
                        "identity": "rim",
                        "map": "N/A"
                    },
                    {
                        "identity": "cda",
                        "map": "ClinicalDocument, if bundle.type = document"
                    }
                ]
            },
            {
                "id": "Bundle.identifier",
                "path": "Bundle.identifier",
                "short": "Persistent identifier for the bundle",
                "definition": "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.",
                "comment": "Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents  the .identifier SHALL be populated such that the .identifier is globally unique.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier"
                    }
                ],
                "condition":  [
                    "bdl-9"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.identifier"
                    },
                    {
                        "identity": "cda",
                        "map": "ClinicalDocument.id"
                    }
                ]
            },
            {
                "id": "Bundle.type",
                "path": "Bundle.type",
                "short": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification",
                "definition": "Indicates the purpose of this bundle - how it is intended to be used.",
                "comment": "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "condition":  [
                    "bdl-1",
                    "bdl-2",
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-3c",
                    "bdl-3d",
                    "bdl-7",
                    "bdl-9",
                    "bdl-10",
                    "bdl-11",
                    "bdl-12",
                    "bdl-13",
                    "bdl-14",
                    "bdl-15",
                    "bdl-17",
                    "bdl-18"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "BundleType"
                        }
                    ],
                    "strength": "required",
                    "description": "Indicates the purpose of a bundle - how it is intended to be used.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/bundle-type|5.0.0"
                },
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.class"
                    }
                ]
            },
            {
                "id": "Bundle.timestamp",
                "path": "Bundle.timestamp",
                "short": "When the bundle was assembled",
                "definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
                "comment": "For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.  \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "instant"
                    }
                ],
                "condition":  [
                    "bdl-10"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.init"
                    },
                    {
                        "identity": "cda",
                        "map": "ClinicalDocument.effectiveTime"
                    }
                ]
            },
            {
                "id": "Bundle.total",
                "path": "Bundle.total",
                "short": "If search, the total number of matches",
                "definition": "If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search.  It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.",
                "comment": "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "unsignedInt"
                    }
                ],
                "condition":  [
                    "bdl-1"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.link",
                "path": "Bundle.link",
                "short": "Links related to this Bundle",
                "definition": "A series of links that provide context to this bundle.",
                "comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.  The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.",
                "min": 0,
                "max": "*",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-18"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.link.relation",
                "path": "Bundle.link.relation",
                "short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
                "definition": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "condition":  [
                    "bdl-18"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0"
                }
            },
            {
                "id": "Bundle.link.url",
                "path": "Bundle.link.url",
                "short": "Reference details for the link",
                "definition": "The reference details for the link.",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "condition":  [
                    "bdl-18"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry",
                "path": "Bundle.entry",
                "short": "Entry in the bundle - will have a resource or information",
                "definition": "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
                "min": 0,
                "max": "*",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "orderMeaning": "For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type",
                "constraint":  [
                    {
                        "key": "bdl-8",
                        "severity": "error",
                        "human": "fullUrl cannot be a version specific reference",
                        "expression": "fullUrl.exists() implies fullUrl.contains('/_history/').not()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    },
                    {
                        "key": "bdl-5",
                        "severity": "error",
                        "human": "must be a resource unless there's a request or response",
                        "expression": "resource.exists() or request.exists() or response.exists()",
                        "source": "http://hl7.org/fhir/StructureDefinition/Bundle"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.link",
                "path": "Bundle.entry.link",
                "short": "Links related to this entry",
                "definition": "A series of links that provide context to this entry.",
                "min": 0,
                "max": "*",
                "contentReference": "#Bundle.link",
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "short": "URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)",
                "definition": "The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: \n* invoking a create\n* invoking or responding to an operation where the body is not a single identified resource\n* invoking or returning the results of a search or history operation.",
                "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "condition":  [
                    "bdl-7",
                    "bdl-15",
                    "bdl-8"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.resource",
                "path": "Bundle.entry.resource",
                "short": "A resource in the bundle",
                "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Resource"
                    }
                ],
                "condition":  [
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-3c",
                    "bdl-7",
                    "bdl-11",
                    "bdl-12",
                    "bdl-13",
                    "bdl-5"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.search",
                "path": "Bundle.entry.search",
                "short": "Search related information",
                "definition": "Information about the search process that lead to the creation of this entry.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-2"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.search.mode",
                "path": "Bundle.entry.search.mode",
                "short": "match | include - why this is in the result set",
                "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
                "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "SearchEntryMode"
                        }
                    ],
                    "strength": "required",
                    "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0"
                }
            },
            {
                "id": "Bundle.entry.search.score",
                "path": "Bundle.entry.search.score",
                "short": "Search ranking (between 0 and 1)",
                "definition": "When searching, the server's search ranking score for the entry.",
                "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "decimal"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request",
                "path": "Bundle.entry.request",
                "short": "Additional execution information (transaction/batch/history)",
                "definition": "Additional information about how this entry should be processed as part of a transaction or batch.  For history, it shows how the entry was processed to create the version contained in the entry.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-5"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.method",
                "path": "Bundle.entry.request.method",
                "short": "GET | HEAD | POST | PUT | DELETE | PATCH",
                "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "condition":  [
                    "bdl-3b",
                    "bdl-3c",
                    "bdl-14",
                    "bdl-15"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "HTTPVerb"
                        }
                    ],
                    "strength": "required",
                    "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|5.0.0"
                }
            },
            {
                "id": "Bundle.entry.request.url",
                "path": "Bundle.entry.request.url",
                "short": "URL for HTTP equivalent of this entry",
                "definition": "The URL for this entry, relative to the root (the address to which the request is posted).",
                "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifNoneMatch",
                "path": "Bundle.entry.request.ifNoneMatch",
                "short": "For managing cache validation",
                "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifModifiedSince",
                "path": "Bundle.entry.request.ifModifiedSince",
                "short": "For managing cache currency",
                "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "instant"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifMatch",
                "path": "Bundle.entry.request.ifMatch",
                "short": "For managing update contention",
                "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.request.ifNoneExist",
                "path": "Bundle.entry.request.ifNoneExist",
                "short": "For conditional creates",
                "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response",
                "path": "Bundle.entry.response",
                "short": "Results of execution (transaction/batch/history)",
                "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "condition":  [
                    "bdl-3a",
                    "bdl-3b",
                    "bdl-3d",
                    "bdl-5"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.status",
                "path": "Bundle.entry.response.status",
                "short": "Status response code (text optional)",
                "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.location",
                "path": "Bundle.entry.response.location",
                "short": "The location (if the operation returns a location)",
                "definition": "The location header created by processing this operation, populated if the operation returns a location.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.etag",
                "path": "Bundle.entry.response.etag",
                "short": "The Etag for the resource (if relevant)",
                "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).",
                "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.lastModified",
                "path": "Bundle.entry.response.lastModified",
                "short": "Server's date time modified",
                "definition": "The date/time that the resource was modified on the server.",
                "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "instant"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.entry.response.outcome",
                "path": "Bundle.entry.response.outcome",
                "short": "OperationOutcome with hints and warnings (for batch/transaction)",
                "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
                "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Resource"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.signature",
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
                        "valueCode": "trial-use"
                    }
                ],
                "path": "Bundle.signature",
                "short": "Digital Signature",
                "definition": "Digital Signature - base64 encoded. XML-DSig or a JWS.",
                "comment": "The signature could be created by the \"author\" of the bundle or by the originating device.   Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.",
                "requirements": "A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Signature"
                    }
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            },
            {
                "id": "Bundle.issues",
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
                        "valueCode": "trial-use"
                    }
                ],
                "path": "Bundle.issues",
                "short": "Issues with the Bundle",
                "definition": "Captures issues and warnings that relate to the construction of the Bundle and the content within it.",
                "comment": "Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry.  If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Resource",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
                        ]
                    }
                ],
                "condition":  [
                    "bdl-16",
                    "bdl-17"
                ],
                "mustSupport": false,
                "isModifier": false,
                "isSummary": true
            }
        ]
    }
}

DocumentReference

idΣ0..1id
id0..1string
extensionI0..*Extension
versionIdΣ0..0id
lastUpdatedΣ0..0instant
sourceΣ1..1uri
profileΣ0..0canonical(StructureDefinition)
securityΣ I0..0CodingBinding
tagΣ I0..0Coding
implicitRulesΣ ?!0..0uri
language0..0codeBinding
textI0..0Narrative
containedI0..0Resource
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ I1..1stringFixed Value
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
versionΣ0..0string
basedOnI0..0Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription)
statusΣ ?!1..1codeBindingFixed Value
docStatusΣ1..1codeBindingFixed Value
modalityΣ0..0CodeableConceptBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ I1..1codeBindingFixed Value
displayΣ I0..0string
userSelectedΣ0..0boolean
textΣ0..0string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ I1..1codeBinding
displayΣ I0..0string
userSelectedΣ0..0boolean
textΣ0..0string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ I1..1stringFixed Value
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
displayΣ I0..0string
contextI0..0Reference(Appointment | Encounter | EpisodeOfCare)
event0..0CodeableReference()
bodySiteΣ0..0CodeableReference(BodyStructure)
facilityTypeI0..0CodeableConcept
practiceSettingI0..0CodeableConcept
periodΣ I0..0Period
dateΣ1..1instant
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ I1..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
displayΣ I0..0string
custodianI0..0Reference(Organization)
descriptionΣ0..0markdown
securityLabelΣ0..0CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
contentTypeΣ I1..1codeBinding
languageΣ0..0codeBinding
dataI0..0base64Binary
urlΣ1..1url
sizeΣ0..0integer64
hashΣ0..0base64Binary
titleΣ0..0string
creationΣ0..0dateTime
height0..0positiveInt
width0..0positiveInt
frames0..0positiveInt
duration0..0decimal
pages0..0positiveInt
DocumentReference
DefinitionA reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.
Cardinality0...*
Comments

Usually, this is used for documents other than those defined by FHIR.

Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: 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
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • docRef-1: facilityType SHALL only be present if context is not an encounter
    facilityType.empty() or context.where(resolve() is Encounter).empty()
  • docRef-2: practiceSetting SHALL only be present if context is not present
    practiceSetting.empty() or context.where(resolve() is Encounter).empty()
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: Entity, Role, or Act
  • workflow: Event
  • w5: infrastructure.documents
  • fhircomposition: when describing a Composition
  • rim: Document[classCode="DOC" and moodCode="EVN"]
  • xds: DocumentEntry
  • cda: when describing a CDA
DocumentReference.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

DocumentReference.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality1...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...0
Typeid
SummaryTrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
DocumentReference.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...0
Typeinstant
SummaryTrue
Comments

This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
DocumentReference.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality1...1
Typeuri
SummaryTrue
Comments

The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
DocumentReference.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality0...0
Typecanonical(StructureDefinition)
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
DocumentReference.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...0
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
    code.exists().not() implies display.exists().not()
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
DocumentReference.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...0
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
    code.exists().not() implies display.exists().not()
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
DocumentReference.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...0
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
DocumentReference.language
DefinitionThe base language in which the resource is written.
Cardinality0...0
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
DocumentReference.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...0
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
DocumentReference.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Cardinality0...0
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: N/A
DocumentReference.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.identifier
DefinitionOther business identifiers associated with the document, including version independent identifiers.
Cardinality1...1
TypeIdentifier
SummaryTrue
Requirements

Document identifiers usually assigned by the source of the document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the document.

Comments

The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • fhircomposition: Composition.identifier
  • v2: TXA-12
  • rim: .id / .setId
  • xds: DocumentEntry.entryUUID, DocumentEntry.uniqueId
  • cda: ClinicalDocument/id
DocumentReference.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...0
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
DocumentReference.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...0
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
DocumentReference.identifier.system
DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
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.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://ihis.sg/identifier/ccda

Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
DocumentReference.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

guid

Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
DocumentReference.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...0
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
DocumentReference.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...0
TypeReference(Organization)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
DocumentReference.version
DefinitionAn explicitly assigned identifer of a variation of the content in the DocumentReference.
Cardinality0...0
Typestring
SummaryTrue
Comments

While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.version
  • fhircomposition: Composition.version
DocumentReference.basedOn
DefinitionA procedure that is fulfilled in whole or in part by the creation of this media.
Cardinality0...0
TypeReference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription)
Aliasfulfills
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=FLFS].target
  • xds: DocumentEntry.referenceIdList
DocumentReference.status
DefinitionThe status of this document reference.
Cardinality1...1
Typecode
Binding

The status of the document reference.

DocumentReferenceStatus (required)
ModifierTrue
SummaryTrue
Comments

This is the status of the DocumentReference object, which might be independent from the docStatus element.

This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

current

Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • v2: TXA-19
  • rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
  • xds: DocumentEntry.availabilityStatus
DocumentReference.docStatus
DefinitionThe status of the underlying document.
Cardinality1...1
Typecode
Binding

Status of the underlying document.

CompositionStatus (required)
SummaryTrue
Comments

The document that is pointed to might be in various lifecycle states.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

final

Mappings
  • rim: n/a
  • w5: FiveWs.status
  • fhircomposition: Composition.status
  • v2: TXA-17
  • rim: .statusCode
DocumentReference.modality
DefinitionImaging modality used. This may include both acquisition and non-acquisition modalities.
Cardinality0...0
TypeCodeableConcept
Binding

Type of acquired data in the instance.

http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html (extensible)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
DocumentReference.type
DefinitionSpecifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
Cardinality1...1
TypeCodeableConcept
Binding

Precise type of clinical document.

FHIRDocumentTypeCodes (preferred)
SummaryTrue
Comments

Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.code
  • w5: FiveWs.what[x]
  • fhircomposition: Composition.type
  • v2: TXA-2
  • rim: ./code
  • xds: DocumentEntry.typeCode
  • cda: ClinicalDocument/code/@code The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.
DocumentReference.type.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.type.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.type.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
    code.exists().not() implies display.exists().not()
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
DocumentReference.type.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.type.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.type.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://ihis.sg/cs/document-type

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
DocumentReference.type.coding.version
DefinitionThe 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.
Cardinality0...0
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
DocumentReference.type.coding.code
DefinitionA 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).
Cardinality1...1
Typecode
BindingSynapxe_Document_Type_Code_System (required)
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

ccda

Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
DocumentReference.type.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...0
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
DocumentReference.type.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
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.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
DocumentReference.type.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...0
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
DocumentReference.category
DefinitionA categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
Cardinality1...1
TypeCodeableConcept
Binding

High-level kind of document at a macro level.

ReferencedItemCategoryValueSet (example)
SummaryTrue
Aliasclass, classCode
Comments

Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.what[x]
  • fhircomposition: Composition.category
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • xds: DocumentEntry.classCode
  • cda: Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code
DocumentReference.category.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.category.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.category.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
    code.exists().not() implies display.exists().not()
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
DocumentReference.category.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.category.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.category.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://ihis.sg/cs/ccda-data-group

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
DocumentReference.category.coding.version
DefinitionThe 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.
Cardinality0...0
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
DocumentReference.category.coding.code
DefinitionA 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).
Cardinality1...1
Typecode
BindingSynapxe_CCDA_Data_Group_Code_System (required)
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
DocumentReference.category.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...0
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
DocumentReference.category.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
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.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
DocumentReference.category.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...0
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
DocumentReference.subject
DefinitionWho or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
Cardinality1...1
TypeReference(Resource)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • fhircomposition: Composition.subject
  • v2: PID-3 (No standard way to define a Practitioner or Group subject in HL7 V2 MDM message)
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • xds: DocumentEntry.patientId
  • cda: ClinicalDocument/recordTarget/
DocumentReference.subject.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.subject.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.subject.reference
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.subject.type
DefinitionThe 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).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

Patient

Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.subject.identifier
DefinitionAn 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.
Cardinality1...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
DocumentReference.subject.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.subject.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.subject.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...0
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
DocumentReference.subject.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...0
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
DocumentReference.subject.identifier.system
DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
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.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://ihis.sg/identifier/encrypted-nric

Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
DocumentReference.subject.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

U2FsdGVkX1-eXowTVO3diSIV_xq8kIME4BxcsYYrh-s=

Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
DocumentReference.subject.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...0
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
DocumentReference.subject.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...0
TypeReference(Organization)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
DocumentReference.subject.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.context
DefinitionDescribes the clinical encounter or type of care that the document content is associated with.
Cardinality0...0
TypeReference(Appointment | Encounter | EpisodeOfCare)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.encounter
  • w5: FiveWs.context
  • fhircomposition: Composition.encounter
  • rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
DocumentReference.event
DefinitionThis list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
Cardinality0...0
TypeCodeableReference()
Binding

This list of codes represents the main clinical acts being documented.

http://terminology.hl7.org/ValueSet/v3-ActCode (example)
Comments

An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Composition.event.detail
  • rim: .code
  • xds: DocumentEntry.referenceIdList
DocumentReference.bodySite
DefinitionThe anatomic structures included in the document.
Cardinality0...0
TypeCodeableReference(BodyStructure)
Binding

SNOMED CT Body site concepts

SNOMEDCTBodyStructures (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .targetSiteCode
DocumentReference.facilityType
DefinitionThe kind of facility where the patient was seen.
Cardinality0...0
TypeCodeableConcept
Binding

XDS Facility Type.

FacilityTypeCodeValueSet (example)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: usually from a mapping to a local ValueSet
  • rim: .participation[typeCode="LOC"].role[classCode="DSDLOC"].code
  • xds: DocumentEntry.healthcareFacilityTypeCode
  • cda: usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code
DocumentReference.practiceSetting
DefinitionThis property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
Cardinality0...0
TypeCodeableConcept
Binding

Additional details about where the content was created (e.g. clinical specialty).

PracticeSettingCodeValueSet (example)
Requirements

This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.

Comments

This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: usually from a mapping to a local ValueSet
  • rim: .participation[typeCode="LOC"].role[classCode="DSDLOC"].code
  • xds: DocumentEntry.practiceSettingCode
  • cda: usually from a mapping to a local ValueSet
DocumentReference.period
DefinitionThe time period over which the service that is described by the document was provided.
Cardinality0...0
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • fhircomposition: Composition.event.period
  • rim: .effectiveTime
  • xds: DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime
  • cda: ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
DocumentReference.date
DefinitionWhen the document reference was created.
Cardinality1...1
Typeinstant
SummaryTrue
Aliasindexed
Comments

Referencing/indexing time is used for tracking, organizing versions and searching.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.occurrence[x]
  • w5: FiveWs.recorded
  • fhircomposition: Composition.date
  • rim: .availabilityTime[type="TS"]
DocumentReference.author
DefinitionIdentifies who is responsible for adding the information to the document.
Cardinality1...1
TypeReference(Organization)
SummaryTrue
Comments

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • fhircomposition: Composition.author
  • v2: TXA-9 (No standard way to indicate a Device in HL7 V2 MDM message)
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • xds: DocumentEntry.author
  • cda: ClinicalDocument/author
DocumentReference.author.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.author.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.author.reference
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.author.type
DefinitionThe 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).
Cardinality1...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

Organization

Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.author.identifier
DefinitionAn 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.
Cardinality1...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
DocumentReference.author.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.author.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.author.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...0
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
DocumentReference.author.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...0
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
DocumentReference.author.identifier.system
DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
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.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://ihis.sg/identifier/institution-code

Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
DocumentReference.author.identifier.value
Definitioninstitution short code
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
DocumentReference.author.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...0
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
DocumentReference.author.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...0
TypeReference(Organization)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
DocumentReference.author.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.attester
DefinitionA participant who has authenticated the accuracy of the document.
Cardinality0...0
TypeBackboneElement
Requirements

Identifies responsibility for the accuracy of the document content.

Comments

Only list each attester once.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.performer.actor
  • fhircomposition: Composition.attester
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • xds: DocumentEntry.legalAuthenticator
  • cda: .authenticator/.legalAuthenticator
DocumentReference.attester.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.attester.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.attester.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.attester.mode
DefinitionThe type of attestation the authenticator offers.
Cardinality1...1
TypeCodeableConcept
Binding

The way in which a person authenticated a document.

CompositionAttestationMode (preferred)
Requirements

Indicates the level of authority of the attestation.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: Composition.attester.mode
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
DocumentReference.attester.time
DefinitionWhen the document was attested by the party.
Cardinality0...1
TypedateTime
Requirements

Identifies when the information in the document was deemed accurate. (Things may have changed since then.).

Comments

UTC offset is allowed for dates and partial dates

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Composition.attester.time
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
DocumentReference.attester.party
DefinitionWho attested the document in the specified way.
Cardinality0...1
TypeReference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
Requirements

Identifies who has taken on the responsibility for accuracy of the document content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • fhircomposition: Composition.attester.party
  • v2: TXA-10
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
DocumentReference.custodian
DefinitionIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document.
Cardinality0...0
TypeReference(Organization)
Comments

Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • fhircomposition: Composition.custodian
  • rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
DocumentReference.relatesTo
DefinitionRelationships that this document has with other document references that already exist.
Cardinality0...0
TypeBackboneElement
SummaryTrue
Comments

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Composition.relatesTo
  • rim: .outboundRelationship
  • xds: DocumentEntry Associations
DocumentReference.relatesTo.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.relatesTo.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.relatesTo.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.relatesTo.code
DefinitionThe type of relationship that this document has with anther document.
Cardinality1...1
TypeCodeableConcept
Binding

The type of relationship between the documents.

DocumentRelationshipType (extensible)
SummaryTrue
Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: Composition.relatesTo.type
  • rim: .outboundRelationship.typeCode
  • xds: DocumentEntry Associations type
  • cda: ClinicalDocument/relatedDocument/typeCode
DocumentReference.relatesTo.target
DefinitionThe target document of this relationship.
Cardinality1...1
TypeReference(DocumentReference)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • fhircomposition: Composition.relatesTo.resourceReference
  • rim: .target[classCode="DOC", moodCode="EVN"].id
  • xds: DocumentEntry Associations reference
  • cda: ClinicalDocument/relatedDocument/parentDocument
DocumentReference.description
DefinitionHuman-readable description of the source document.
Cardinality0...0
Typemarkdown
SummaryTrue
Requirements

Helps humans to assess whether the document is of interest.

Comments

What the document is about, a terse summary of the document.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: TXA-25
  • rim: .outboundRelationship[typeCode="SUBJ"].target.text
  • xds: DocumentEntry.comments
DocumentReference.securityLabel
DefinitionA set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.
Cardinality0...0
TypeCodeableConcept
Binding

Example Security Labels from the Healthcare Privacy and Security Classification System.

SecurityLabelExamples (example)
SummaryTrue
Requirements

Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Comments

The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.

In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: Bundle.meta.security
  • v2: TXA-18
  • rim: .confidentialityCode
  • xds: DocumentEntry.confidentialityCode
  • cda: ClinicalDocument/confidentialityCode/@code
DocumentReference.content
DefinitionThe document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.
Cardinality1...*
TypeBackboneElement
SummaryTrue
Requirements

Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.

Comments

content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Bundle(Composition+*)
  • rim: document.text
DocumentReference.content.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.content.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.content.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.content.attachment
DefinitionThe document or URL of the document along with critical metadata to prove content has integrity.
Cardinality1...1
TypeAttachment
SummaryTrue
Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
  • fhircomposition: Composition.language, Composition.title, Composition.date
  • v2: TXA-3 for mime type
  • rim: document.text
  • xds: DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime
  • cda: ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date
DocumentReference.content.attachment.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.content.attachment.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.content.attachment.contentType
DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Cardinality1...1
Typecode
Binding

BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

MimeTypes (required)
SummaryTrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

text/plain; charset=UTF-8, image/png


Mappings
  • rim: n/a
  • v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
  • rim: ./mediaType, ./charset
DocumentReference.content.attachment.language
DefinitionThe human language of the content. The value can be any valid value according to BCP 47.
Cardinality0...0
Typecode
Binding

IETF language tag for a human language.

AllLanguages (required)
SummaryTrue
Requirements

Users need to be able to choose between the languages in a set of attachments.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

en-AU


Mappings
  • rim: n/a
  • rim: ./language
DocumentReference.content.attachment.data
DefinitionThe actual data of the attachment - a sequence of bytes, base64 encoded.
Cardinality0...0
Typebase64Binary
Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: ED.5
  • rim: ./data
DocumentReference.content.attachment.url
DefinitionA location where the data can be accessed.
Cardinality1...1
Typeurl
SummaryTrue
Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/logo-small.png


Mappings
  • rim: n/a
  • v2: RP.1+RP.2 - if they refer to a URL (see v2.6)
  • rim: ./reference/literal
DocumentReference.content.attachment.size
DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Cardinality0...0
Typeinteger64
SummaryTrue
Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A (needs data type R3 proposal)
DocumentReference.content.attachment.hash
DefinitionThe calculated hash of the data using SHA-1. Represented using base64.
Cardinality0...0
Typebase64Binary
SummaryTrue
Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
DocumentReference.content.attachment.title
DefinitionA label or set of text to display in place of the data.
Cardinality0...0
Typestring
SummaryTrue
Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Comments

May sometimes be derived from the source filename.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

Official Corporate Logo


Mappings
  • rim: n/a
  • rim: ./title/data
DocumentReference.content.attachment.creation
DefinitionThe date that the attachment was first created.
Cardinality0...0
TypedateTime
SummaryTrue
Requirements

This is often tracked as an integrity issue for use of the attachment.

Comments

UTC offset is allowed for dates and partial dates

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A (needs data type R3 proposal)
DocumentReference.content.attachment.height
DefinitionHeight of the image in pixels (photo/video).
Cardinality0...0
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
DocumentReference.content.attachment.width
DefinitionWidth of the image in pixels (photo/video).
Cardinality0...0
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
DocumentReference.content.attachment.frames
DefinitionThe number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
Cardinality0...0
TypepositiveInt
Comments

if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
DocumentReference.content.attachment.duration
DefinitionThe duration of the recording in seconds - for audio and video.
Cardinality0...0
Typedecimal
Comments

The duration might differ from occurrencePeriod if recording was paused.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
DocumentReference.content.attachment.pages
DefinitionThe number of pages when printed.
Cardinality0...0
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
DocumentReference.content.profile
DefinitionAn identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
Cardinality0...0
TypeBackboneElement
SummaryTrue
Aliasformat, formatCode
Comments

Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.

For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Composition.meta.profile
  • rim: document.text
  • xds: DocumentEntry.formatCode
  • cda: derived from the IHE Profile or Implementation Guide templateID
DocumentReference.content.profile.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DocumentReference.content.profile.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.content.profile.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
DocumentReference.content.profile.value[x]
DefinitionCode|uri|canonical.
Cardinality1...1
TypeCoding
Binding

Document Format Codes.

http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes (preferred)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Composition.meta.profile
  • rim: document.text
  • xds: DocumentEntry.formatCode
  • cda: derived from the IHE Profile or Implementation Guide templateID
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://fhir.synapxe.sg/StructureDefinition/profile-documentreference" />
    <name value="DocumentReference" />
    <status value="draft" />
    <fhirVersion value="5.0.0" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="DocumentReference" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DocumentReference" />
    <derivation value="constraint" />
    <differential>
        <element id="DocumentReference.meta">
            <path value="DocumentReference.meta" />
            <min value="1" />
        </element>
        <element id="DocumentReference.meta.versionId">
            <path value="DocumentReference.meta.versionId" />
            <max value="0" />
        </element>
        <element id="DocumentReference.meta.lastUpdated">
            <path value="DocumentReference.meta.lastUpdated" />
            <max value="0" />
        </element>
        <element id="DocumentReference.meta.source">
            <path value="DocumentReference.meta.source" />
            <min value="1" />
        </element>
        <element id="DocumentReference.meta.profile">
            <path value="DocumentReference.meta.profile" />
            <max value="0" />
        </element>
        <element id="DocumentReference.meta.security">
            <path value="DocumentReference.meta.security" />
            <max value="0" />
        </element>
        <element id="DocumentReference.meta.tag">
            <path value="DocumentReference.meta.tag" />
            <max value="0" />
        </element>
        <element id="DocumentReference.implicitRules">
            <path value="DocumentReference.implicitRules" />
            <max value="0" />
        </element>
        <element id="DocumentReference.language">
            <path value="DocumentReference.language" />
            <max value="0" />
        </element>
        <element id="DocumentReference.text">
            <path value="DocumentReference.text" />
            <max value="0" />
        </element>
        <element id="DocumentReference.contained">
            <path value="DocumentReference.contained" />
            <max value="0" />
        </element>
        <element id="DocumentReference.identifier">
            <path value="DocumentReference.identifier" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="DocumentReference.identifier.use">
            <path value="DocumentReference.identifier.use" />
            <max value="0" />
        </element>
        <element id="DocumentReference.identifier.type">
            <path value="DocumentReference.identifier.type" />
            <max value="0" />
        </element>
        <element id="DocumentReference.identifier.system">
            <path value="DocumentReference.identifier.system" />
            <min value="1" />
            <fixedUri value="http://ihis.sg/identifier/ccda" />
        </element>
        <element id="DocumentReference.identifier.value">
            <path value="DocumentReference.identifier.value" />
            <min value="1" />
            <fixedString value="guid" />
        </element>
        <element id="DocumentReference.identifier.period">
            <path value="DocumentReference.identifier.period" />
            <max value="0" />
        </element>
        <element id="DocumentReference.identifier.assigner">
            <path value="DocumentReference.identifier.assigner" />
            <max value="0" />
        </element>
        <element id="DocumentReference.version">
            <path value="DocumentReference.version" />
            <max value="0" />
        </element>
        <element id="DocumentReference.basedOn">
            <path value="DocumentReference.basedOn" />
            <max value="0" />
        </element>
        <element id="DocumentReference.status">
            <path value="DocumentReference.status" />
            <fixedCode value="current" />
        </element>
        <element id="DocumentReference.docStatus">
            <path value="DocumentReference.docStatus" />
            <min value="1" />
            <fixedCode value="final" />
        </element>
        <element id="DocumentReference.modality">
            <path value="DocumentReference.modality" />
            <max value="0" />
        </element>
        <element id="DocumentReference.type">
            <path value="DocumentReference.type" />
            <min value="1" />
        </element>
        <element id="DocumentReference.type.coding">
            <path value="DocumentReference.type.coding" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="DocumentReference.type.coding.system">
            <path value="DocumentReference.type.coding.system" />
            <min value="1" />
            <fixedUri value="http://ihis.sg/cs/document-type" />
        </element>
        <element id="DocumentReference.type.coding.version">
            <path value="DocumentReference.type.coding.version" />
            <max value="0" />
        </element>
        <element id="DocumentReference.type.coding.code">
            <path value="DocumentReference.type.coding.code" />
            <min value="1" />
            <fixedCode value="ccda" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihis.sg/cs/document-type" />
            </binding>
        </element>
        <element id="DocumentReference.type.coding.display">
            <path value="DocumentReference.type.coding.display" />
            <max value="0" />
        </element>
        <element id="DocumentReference.type.coding.userSelected">
            <path value="DocumentReference.type.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="DocumentReference.type.text">
            <path value="DocumentReference.type.text" />
            <max value="0" />
        </element>
        <element id="DocumentReference.category">
            <path value="DocumentReference.category" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="DocumentReference.category.coding">
            <path value="DocumentReference.category.coding" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="DocumentReference.category.coding.system">
            <path value="DocumentReference.category.coding.system" />
            <min value="1" />
            <fixedUri value="http://ihis.sg/cs/ccda-data-group" />
        </element>
        <element id="DocumentReference.category.coding.version">
            <path value="DocumentReference.category.coding.version" />
            <max value="0" />
        </element>
        <element id="DocumentReference.category.coding.code">
            <path value="DocumentReference.category.coding.code" />
            <min value="1" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihis.sg/cs/ccda-data-group" />
            </binding>
        </element>
        <element id="DocumentReference.category.coding.display">
            <path value="DocumentReference.category.coding.display" />
            <max value="0" />
        </element>
        <element id="DocumentReference.category.coding.userSelected">
            <path value="DocumentReference.category.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="DocumentReference.category.text">
            <path value="DocumentReference.category.text" />
            <max value="0" />
        </element>
        <element id="DocumentReference.subject">
            <path value="DocumentReference.subject" />
            <min value="1" />
        </element>
        <element id="DocumentReference.subject.type">
            <path value="DocumentReference.subject.type" />
            <fixedUri value="Patient" />
        </element>
        <element id="DocumentReference.subject.identifier">
            <path value="DocumentReference.subject.identifier" />
            <min value="1" />
        </element>
        <element id="DocumentReference.subject.identifier.use">
            <path value="DocumentReference.subject.identifier.use" />
            <max value="0" />
        </element>
        <element id="DocumentReference.subject.identifier.type">
            <path value="DocumentReference.subject.identifier.type" />
            <max value="0" />
        </element>
        <element id="DocumentReference.subject.identifier.system">
            <path value="DocumentReference.subject.identifier.system" />
            <min value="1" />
            <fixedUri value="http://ihis.sg/identifier/encrypted-nric" />
        </element>
        <element id="DocumentReference.subject.identifier.value">
            <path value="DocumentReference.subject.identifier.value" />
            <min value="1" />
            <fixedString value="U2FsdGVkX1-eXowTVO3diSIV_xq8kIME4BxcsYYrh-s=" />
        </element>
        <element id="DocumentReference.subject.identifier.period">
            <path value="DocumentReference.subject.identifier.period" />
            <max value="0" />
        </element>
        <element id="DocumentReference.subject.identifier.assigner">
            <path value="DocumentReference.subject.identifier.assigner" />
            <max value="0" />
        </element>
        <element id="DocumentReference.subject.display">
            <path value="DocumentReference.subject.display" />
            <max value="0" />
        </element>
        <element id="DocumentReference.context">
            <path value="DocumentReference.context" />
            <max value="0" />
        </element>
        <element id="DocumentReference.event">
            <path value="DocumentReference.event" />
            <max value="0" />
        </element>
        <element id="DocumentReference.bodySite">
            <path value="DocumentReference.bodySite" />
            <max value="0" />
        </element>
        <element id="DocumentReference.facilityType">
            <path value="DocumentReference.facilityType" />
            <max value="0" />
        </element>
        <element id="DocumentReference.practiceSetting">
            <path value="DocumentReference.practiceSetting" />
            <max value="0" />
        </element>
        <element id="DocumentReference.period">
            <path value="DocumentReference.period" />
            <max value="0" />
        </element>
        <element id="DocumentReference.date">
            <path value="DocumentReference.date" />
            <min value="1" />
        </element>
        <element id="DocumentReference.author">
            <path value="DocumentReference.author" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
            </type>
        </element>
        <element id="DocumentReference.author.type">
            <path value="DocumentReference.author.type" />
            <min value="1" />
            <fixedUri value="Organization" />
        </element>
        <element id="DocumentReference.author.identifier">
            <path value="DocumentReference.author.identifier" />
            <min value="1" />
        </element>
        <element id="DocumentReference.author.identifier.use">
            <path value="DocumentReference.author.identifier.use" />
            <max value="0" />
        </element>
        <element id="DocumentReference.author.identifier.type">
            <path value="DocumentReference.author.identifier.type" />
            <max value="0" />
        </element>
        <element id="DocumentReference.author.identifier.system">
            <path value="DocumentReference.author.identifier.system" />
            <min value="1" />
            <fixedUri value="http://ihis.sg/identifier/institution-code" />
        </element>
        <element id="DocumentReference.author.identifier.value">
            <path value="DocumentReference.author.identifier.value" />
            <short value="institution short code" />
            <definition value="institution short code" />
            <min value="1" />
        </element>
        <element id="DocumentReference.author.identifier.period">
            <path value="DocumentReference.author.identifier.period" />
            <max value="0" />
        </element>
        <element id="DocumentReference.author.identifier.assigner">
            <path value="DocumentReference.author.identifier.assigner" />
            <max value="0" />
        </element>
        <element id="DocumentReference.author.display">
            <path value="DocumentReference.author.display" />
            <max value="0" />
        </element>
        <element id="DocumentReference.attester">
            <path value="DocumentReference.attester" />
            <max value="0" />
        </element>
        <element id="DocumentReference.custodian">
            <path value="DocumentReference.custodian" />
            <max value="0" />
        </element>
        <element id="DocumentReference.relatesTo">
            <path value="DocumentReference.relatesTo" />
            <max value="0" />
        </element>
        <element id="DocumentReference.description">
            <path value="DocumentReference.description" />
            <max value="0" />
        </element>
        <element id="DocumentReference.securityLabel">
            <path value="DocumentReference.securityLabel" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.contentType">
            <path value="DocumentReference.content.attachment.contentType" />
            <min value="1" />
        </element>
        <element id="DocumentReference.content.attachment.language">
            <path value="DocumentReference.content.attachment.language" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.data">
            <path value="DocumentReference.content.attachment.data" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.url">
            <path value="DocumentReference.content.attachment.url" />
            <min value="1" />
        </element>
        <element id="DocumentReference.content.attachment.size">
            <path value="DocumentReference.content.attachment.size" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.hash">
            <path value="DocumentReference.content.attachment.hash" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.title">
            <path value="DocumentReference.content.attachment.title" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.creation">
            <path value="DocumentReference.content.attachment.creation" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.height">
            <path value="DocumentReference.content.attachment.height" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.width">
            <path value="DocumentReference.content.attachment.width" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.frames">
            <path value="DocumentReference.content.attachment.frames" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.duration">
            <path value="DocumentReference.content.attachment.duration" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.attachment.pages">
            <path value="DocumentReference.content.attachment.pages" />
            <max value="0" />
        </element>
        <element id="DocumentReference.content.profile">
            <path value="DocumentReference.content.profile" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "url": "http://fhir.synapxe.sg/StructureDefinition/profile-documentreference",
    "name": "DocumentReference",
    "status": "draft",
    "fhirVersion": "5.0.0",
    "kind": "resource",
    "abstract": false,
    "type": "DocumentReference",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "DocumentReference.meta",
                "path": "DocumentReference.meta",
                "min": 1
            },
            {
                "id": "DocumentReference.meta.versionId",
                "path": "DocumentReference.meta.versionId",
                "max": "0"
            },
            {
                "id": "DocumentReference.meta.lastUpdated",
                "path": "DocumentReference.meta.lastUpdated",
                "max": "0"
            },
            {
                "id": "DocumentReference.meta.source",
                "path": "DocumentReference.meta.source",
                "min": 1
            },
            {
                "id": "DocumentReference.meta.profile",
                "path": "DocumentReference.meta.profile",
                "max": "0"
            },
            {
                "id": "DocumentReference.meta.security",
                "path": "DocumentReference.meta.security",
                "max": "0"
            },
            {
                "id": "DocumentReference.meta.tag",
                "path": "DocumentReference.meta.tag",
                "max": "0"
            },
            {
                "id": "DocumentReference.implicitRules",
                "path": "DocumentReference.implicitRules",
                "max": "0"
            },
            {
                "id": "DocumentReference.language",
                "path": "DocumentReference.language",
                "max": "0"
            },
            {
                "id": "DocumentReference.text",
                "path": "DocumentReference.text",
                "max": "0"
            },
            {
                "id": "DocumentReference.contained",
                "path": "DocumentReference.contained",
                "max": "0"
            },
            {
                "id": "DocumentReference.identifier",
                "path": "DocumentReference.identifier",
                "min": 1,
                "max": "1"
            },
            {
                "id": "DocumentReference.identifier.use",
                "path": "DocumentReference.identifier.use",
                "max": "0"
            },
            {
                "id": "DocumentReference.identifier.type",
                "path": "DocumentReference.identifier.type",
                "max": "0"
            },
            {
                "id": "DocumentReference.identifier.system",
                "path": "DocumentReference.identifier.system",
                "min": 1,
                "fixedUri": "http://ihis.sg/identifier/ccda"
            },
            {
                "id": "DocumentReference.identifier.value",
                "path": "DocumentReference.identifier.value",
                "min": 1,
                "fixedString": "guid"
            },
            {
                "id": "DocumentReference.identifier.period",
                "path": "DocumentReference.identifier.period",
                "max": "0"
            },
            {
                "id": "DocumentReference.identifier.assigner",
                "path": "DocumentReference.identifier.assigner",
                "max": "0"
            },
            {
                "id": "DocumentReference.version",
                "path": "DocumentReference.version",
                "max": "0"
            },
            {
                "id": "DocumentReference.basedOn",
                "path": "DocumentReference.basedOn",
                "max": "0"
            },
            {
                "id": "DocumentReference.status",
                "path": "DocumentReference.status",
                "fixedCode": "current"
            },
            {
                "id": "DocumentReference.docStatus",
                "path": "DocumentReference.docStatus",
                "min": 1,
                "fixedCode": "final"
            },
            {
                "id": "DocumentReference.modality",
                "path": "DocumentReference.modality",
                "max": "0"
            },
            {
                "id": "DocumentReference.type",
                "path": "DocumentReference.type",
                "min": 1
            },
            {
                "id": "DocumentReference.type.coding",
                "path": "DocumentReference.type.coding",
                "min": 1,
                "max": "1"
            },
            {
                "id": "DocumentReference.type.coding.system",
                "path": "DocumentReference.type.coding.system",
                "min": 1,
                "fixedUri": "http://ihis.sg/cs/document-type"
            },
            {
                "id": "DocumentReference.type.coding.version",
                "path": "DocumentReference.type.coding.version",
                "max": "0"
            },
            {
                "id": "DocumentReference.type.coding.code",
                "path": "DocumentReference.type.coding.code",
                "min": 1,
                "fixedCode": "ccda",
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihis.sg/cs/document-type"
                }
            },
            {
                "id": "DocumentReference.type.coding.display",
                "path": "DocumentReference.type.coding.display",
                "max": "0"
            },
            {
                "id": "DocumentReference.type.coding.userSelected",
                "path": "DocumentReference.type.coding.userSelected",
                "max": "0"
            },
            {
                "id": "DocumentReference.type.text",
                "path": "DocumentReference.type.text",
                "max": "0"
            },
            {
                "id": "DocumentReference.category",
                "path": "DocumentReference.category",
                "min": 1,
                "max": "1"
            },
            {
                "id": "DocumentReference.category.coding",
                "path": "DocumentReference.category.coding",
                "min": 1,
                "max": "1"
            },
            {
                "id": "DocumentReference.category.coding.system",
                "path": "DocumentReference.category.coding.system",
                "min": 1,
                "fixedUri": "http://ihis.sg/cs/ccda-data-group"
            },
            {
                "id": "DocumentReference.category.coding.version",
                "path": "DocumentReference.category.coding.version",
                "max": "0"
            },
            {
                "id": "DocumentReference.category.coding.code",
                "path": "DocumentReference.category.coding.code",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihis.sg/cs/ccda-data-group"
                }
            },
            {
                "id": "DocumentReference.category.coding.display",
                "path": "DocumentReference.category.coding.display",
                "max": "0"
            },
            {
                "id": "DocumentReference.category.coding.userSelected",
                "path": "DocumentReference.category.coding.userSelected",
                "max": "0"
            },
            {
                "id": "DocumentReference.category.text",
                "path": "DocumentReference.category.text",
                "max": "0"
            },
            {
                "id": "DocumentReference.subject",
                "path": "DocumentReference.subject",
                "min": 1
            },
            {
                "id": "DocumentReference.subject.type",
                "path": "DocumentReference.subject.type",
                "fixedUri": "Patient"
            },
            {
                "id": "DocumentReference.subject.identifier",
                "path": "DocumentReference.subject.identifier",
                "min": 1
            },
            {
                "id": "DocumentReference.subject.identifier.use",
                "path": "DocumentReference.subject.identifier.use",
                "max": "0"
            },
            {
                "id": "DocumentReference.subject.identifier.type",
                "path": "DocumentReference.subject.identifier.type",
                "max": "0"
            },
            {
                "id": "DocumentReference.subject.identifier.system",
                "path": "DocumentReference.subject.identifier.system",
                "min": 1,
                "fixedUri": "http://ihis.sg/identifier/encrypted-nric"
            },
            {
                "id": "DocumentReference.subject.identifier.value",
                "path": "DocumentReference.subject.identifier.value",
                "min": 1,
                "fixedString": "U2FsdGVkX1-eXowTVO3diSIV_xq8kIME4BxcsYYrh-s="
            },
            {
                "id": "DocumentReference.subject.identifier.period",
                "path": "DocumentReference.subject.identifier.period",
                "max": "0"
            },
            {
                "id": "DocumentReference.subject.identifier.assigner",
                "path": "DocumentReference.subject.identifier.assigner",
                "max": "0"
            },
            {
                "id": "DocumentReference.subject.display",
                "path": "DocumentReference.subject.display",
                "max": "0"
            },
            {
                "id": "DocumentReference.context",
                "path": "DocumentReference.context",
                "max": "0"
            },
            {
                "id": "DocumentReference.event",
                "path": "DocumentReference.event",
                "max": "0"
            },
            {
                "id": "DocumentReference.bodySite",
                "path": "DocumentReference.bodySite",
                "max": "0"
            },
            {
                "id": "DocumentReference.facilityType",
                "path": "DocumentReference.facilityType",
                "max": "0"
            },
            {
                "id": "DocumentReference.practiceSetting",
                "path": "DocumentReference.practiceSetting",
                "max": "0"
            },
            {
                "id": "DocumentReference.period",
                "path": "DocumentReference.period",
                "max": "0"
            },
            {
                "id": "DocumentReference.date",
                "path": "DocumentReference.date",
                "min": 1
            },
            {
                "id": "DocumentReference.author",
                "path": "DocumentReference.author",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Organization"
                        ]
                    }
                ]
            },
            {
                "id": "DocumentReference.author.type",
                "path": "DocumentReference.author.type",
                "min": 1,
                "fixedUri": "Organization"
            },
            {
                "id": "DocumentReference.author.identifier",
                "path": "DocumentReference.author.identifier",
                "min": 1
            },
            {
                "id": "DocumentReference.author.identifier.use",
                "path": "DocumentReference.author.identifier.use",
                "max": "0"
            },
            {
                "id": "DocumentReference.author.identifier.type",
                "path": "DocumentReference.author.identifier.type",
                "max": "0"
            },
            {
                "id": "DocumentReference.author.identifier.system",
                "path": "DocumentReference.author.identifier.system",
                "min": 1,
                "fixedUri": "http://ihis.sg/identifier/institution-code"
            },
            {
                "id": "DocumentReference.author.identifier.value",
                "path": "DocumentReference.author.identifier.value",
                "short": "institution short code",
                "definition": "institution short code",
                "min": 1
            },
            {
                "id": "DocumentReference.author.identifier.period",
                "path": "DocumentReference.author.identifier.period",
                "max": "0"
            },
            {
                "id": "DocumentReference.author.identifier.assigner",
                "path": "DocumentReference.author.identifier.assigner",
                "max": "0"
            },
            {
                "id": "DocumentReference.author.display",
                "path": "DocumentReference.author.display",
                "max": "0"
            },
            {
                "id": "DocumentReference.attester",
                "path": "DocumentReference.attester",
                "max": "0"
            },
            {
                "id": "DocumentReference.custodian",
                "path": "DocumentReference.custodian",
                "max": "0"
            },
            {
                "id": "DocumentReference.relatesTo",
                "path": "DocumentReference.relatesTo",
                "max": "0"
            },
            {
                "id": "DocumentReference.description",
                "path": "DocumentReference.description",
                "max": "0"
            },
            {
                "id": "DocumentReference.securityLabel",
                "path": "DocumentReference.securityLabel",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.contentType",
                "path": "DocumentReference.content.attachment.contentType",
                "min": 1
            },
            {
                "id": "DocumentReference.content.attachment.language",
                "path": "DocumentReference.content.attachment.language",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.data",
                "path": "DocumentReference.content.attachment.data",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.url",
                "path": "DocumentReference.content.attachment.url",
                "min": 1
            },
            {
                "id": "DocumentReference.content.attachment.size",
                "path": "DocumentReference.content.attachment.size",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.hash",
                "path": "DocumentReference.content.attachment.hash",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.title",
                "path": "DocumentReference.content.attachment.title",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.creation",
                "path": "DocumentReference.content.attachment.creation",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.height",
                "path": "DocumentReference.content.attachment.height",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.width",
                "path": "DocumentReference.content.attachment.width",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.frames",
                "path": "DocumentReference.content.attachment.frames",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.duration",
                "path": "DocumentReference.content.attachment.duration",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.attachment.pages",
                "path": "DocumentReference.content.attachment.pages",
                "max": "0"
            },
            {
                "id": "DocumentReference.content.profile",
                "path": "DocumentReference.content.profile",
                "max": "0"
            }
        ]
    }
}

Terminology Bindings


These are the terminology bindings within these resources:

Path Binding Strength Value Set(Code System) Description
Bundle.type Required Bundle Type (HL7 FHIR) Indicates the purpose of a bundle - how it is intended to be used.
DocumentReference.status Required DocumentReference Status (HL7 FHIR) The status of the document reference.
DocumentReference.docStatus Required Composition Status (HL7 FHIR) Status of the underlying document.
DocumentReference.category.coding.code Required Synapxe CCDA Data Group Code System CCDA data group.

Constraints


No constraints