CH EPR mHealth (R4)
3.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR mHealth (R4) (v3.0.0-ballot: Draft Ballot 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH MHD Find Document References Comprehensive Response message

Official URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-documentreference-comprehensive-bundle Version: 3.0.0-ballot
Draft as of 2020-10-14 Computable Name: ChFindDocumentReferencesComprehensiveResponse

Copyright/Legal: CC0-1.0

A profile on the Find Document References Comprehensive Response message for ITI-68

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from FindDocumentReferencesComprehensiveResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*FindDocumentReferencesComprehensiveResponseContains a collection of resources
... Slices for entry S0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:All Slices Content/Rules for all slices
..... fullUrl SC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
ch-mhd-bdl-1: The fullUrl must be an absolute URL server address or an URI for UUID/OID
.... entry:DocumentReference S0..*BackboneElementDocumentReference
..... resource S1..1CHMhdDocumentReferenceComprehensiveCH MHD DocumentReference Comprehensive

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ch-mhd-bdl-1errorBundle.entry.fullUrlThe fullUrl must be an absolute URL server address or an URI for UUID/OID
: startsWith('http') or startsWith('urn:uuid:') = true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*FindDocumentReferencesComprehensiveResponseContains a collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: searchset
... total ΣC1..1unsignedIntIf search, the total number of matches
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl SΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
ch-mhd-bdl-1: The fullUrl must be an absolute URL server address or an URI for UUID/OID
.... entry:DocumentReference SΣC0..*BackboneElementDocumentReference
This repeating element order: 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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SC1..1CHMhdDocumentReferenceComprehensiveCH MHD DocumentReference Comprehensive

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredFixed Value: searchset

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:DocumentReferencemust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:DocumentReferencefullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ch-mhderrorBundle.entry:DocumentReference.resourceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
ch-mhd-bdl-1errorBundle.entry.fullUrlThe fullUrl must be an absolute URL server address or an URI for UUID/OID
: startsWith('http') or startsWith('urn:uuid:') = true
dom-2errorBundle.entry:DocumentReference.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:DocumentReference.resourceIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:DocumentReference.resourceIf 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-5errorBundle.entry:DocumentReference.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:DocumentReference.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
iti-mhd-replerrorBundle.entry:DocumentReference.resourcea DocumetReference replacements needs to relate to a superseded DocumentReference
: relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*FindDocumentReferencesComprehensiveResponseContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: searchset
... timestamp Σ0..1instantWhen the bundle was assembled
... total ΣC1..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
This repeating element order: 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
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
ch-mhd-bdl-1: The fullUrl must be an absolute URL server address or an URI for UUID/OID
..... resource Σ0..1ResourceA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:DocumentReference SΣC0..*BackboneElementDocumentReference
This repeating element order: 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SC1..1CHMhdDocumentReferenceComprehensiveCH MHD DocumentReference Comprehensive
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣTU0..1SignatureDigital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: searchset
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:DocumentReference.search.moderequiredSearchEntryMode
Bundle.entry:DocumentReference.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-5errorBundle.entry, Bundle.entry:DocumentReferencemust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8errorBundle.entry, Bundle.entry:DocumentReferencefullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ch-mhderrorBundle.entry:DocumentReference.resourceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
ch-mhd-bdl-1errorBundle.entry.fullUrlThe fullUrl must be an absolute URL server address or an URI for UUID/OID
: startsWith('http') or startsWith('urn:uuid:') = true
dom-2errorBundle.entry:DocumentReference.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:DocumentReference.resourceIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:DocumentReference.resourceIf 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-5errorBundle.entry:DocumentReference.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:DocumentReference.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
iti-mhd-replerrorBundle.entry:DocumentReference.resourcea DocumetReference replacements needs to relate to a superseded DocumentReference
: relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())

This structure is derived from FindDocumentReferencesComprehensiveResponse

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of profile:resource

Differential View

This structure is derived from FindDocumentReferencesComprehensiveResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*FindDocumentReferencesComprehensiveResponseContains a collection of resources
... Slices for entry S0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:All Slices Content/Rules for all slices
..... fullUrl SC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
ch-mhd-bdl-1: The fullUrl must be an absolute URL server address or an URI for UUID/OID
.... entry:DocumentReference S0..*BackboneElementDocumentReference
..... resource S1..1CHMhdDocumentReferenceComprehensiveCH MHD DocumentReference Comprehensive

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ch-mhd-bdl-1errorBundle.entry.fullUrlThe fullUrl must be an absolute URL server address or an URI for UUID/OID
: startsWith('http') or startsWith('urn:uuid:') = true

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*FindDocumentReferencesComprehensiveResponseContains a collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: searchset
... total ΣC1..1unsignedIntIf search, the total number of matches
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl SΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
ch-mhd-bdl-1: The fullUrl must be an absolute URL server address or an URI for UUID/OID
.... entry:DocumentReference SΣC0..*BackboneElementDocumentReference
This repeating element order: 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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SC1..1CHMhdDocumentReferenceComprehensiveCH MHD DocumentReference Comprehensive

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredFixed Value: searchset

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:DocumentReferencemust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:DocumentReferencefullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ch-mhderrorBundle.entry:DocumentReference.resourceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
ch-mhd-bdl-1errorBundle.entry.fullUrlThe fullUrl must be an absolute URL server address or an URI for UUID/OID
: startsWith('http') or startsWith('urn:uuid:') = true
dom-2errorBundle.entry:DocumentReference.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:DocumentReference.resourceIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:DocumentReference.resourceIf 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-5errorBundle.entry:DocumentReference.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:DocumentReference.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
iti-mhd-replerrorBundle.entry:DocumentReference.resourcea DocumetReference replacements needs to relate to a superseded DocumentReference
: relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*FindDocumentReferencesComprehensiveResponseContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: searchset
... timestamp Σ0..1instantWhen the bundle was assembled
... total ΣC1..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
This repeating element order: 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
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
ch-mhd-bdl-1: The fullUrl must be an absolute URL server address or an URI for UUID/OID
..... resource Σ0..1ResourceA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:DocumentReference SΣC0..*BackboneElementDocumentReference
This repeating element order: 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SC1..1CHMhdDocumentReferenceComprehensiveCH MHD DocumentReference Comprehensive
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣTU0..1SignatureDigital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: searchset
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:DocumentReference.search.moderequiredSearchEntryMode
Bundle.entry:DocumentReference.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-5errorBundle.entry, Bundle.entry:DocumentReferencemust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8errorBundle.entry, Bundle.entry:DocumentReferencefullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ch-mhderrorBundle.entry:DocumentReference.resourceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
ch-mhd-bdl-1errorBundle.entry.fullUrlThe fullUrl must be an absolute URL server address or an URI for UUID/OID
: startsWith('http') or startsWith('urn:uuid:') = true
dom-2errorBundle.entry:DocumentReference.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:DocumentReference.resourceIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:DocumentReference.resourceIf 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-5errorBundle.entry:DocumentReference.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:DocumentReference.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
iti-mhd-replerrorBundle.entry:DocumentReference.resourcea DocumetReference replacements needs to relate to a superseded DocumentReference
: relatesTo.empty() or (relatesTo.code='replaces' implies relatesTo.target.exists())

This structure is derived from FindDocumentReferencesComprehensiveResponse

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of profile:resource

 

Other representations of profile: CSV, Excel, Schematron