Mobile access to Health Documents (MHD)
4.2.1 - Trial-Implementation
Mobile access to Health Documents (MHD), published by IHE IT Infrastructure Technical Committee. This is not an authorized publication; it is the continuous build for version 4.2.1). This version is based on the current content of https://github.com/IHE/ITI.MHD/ and changes regularly. See the Directory of published versions
Official URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.ProvideDocumentBundleResponse | Version: 4.2.1 | |||
Active as of 2023-08-02 | Computable Name: ProvideDocumentBundleResponse |
A profile on the Bundle transaction-response for ITI-65 Provide Document Bundle response.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Bundle | Contains a collection of resources | |
![]() ![]() ![]() | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: transaction-response | |
![]() ![]() ![]() | 1..* | BackboneElement | One entry for each entry in the request, in the same order as received | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Indicating the results of processing the entry | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The location (if the operation returns a location) | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Bundle | Contains a collection of resources |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | Σ | 1..1 | code | document | 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. Required Pattern: transaction-response |
![]() ![]() ![]() | ΣC | 1..* | BackboneElement | One entry for each entry in the request, in the same order as received 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 |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Indicating the results of processing the entry |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The location (if the operation returns a location) |
![]() |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Pattern: transaction-response |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | C | 0..* | Bundle | Contains a collection of resources | ||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() | Σ | 1..1 | code | document | 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. Required Pattern: transaction-response | ||||
![]() ![]() ![]() | Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]() ![]() | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() ![]() | ΣC | 1..* | BackboneElement | One entry for each entry in the request, in the same order as received 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | match | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Indicating the results of processing the entry | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() | ΣTU | 0..1 | Signature | Digital Signature | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
Bundle.language | preferred | CommonLanguages
| ||||
Bundle.type | required | Pattern: transaction-response | ||||
Bundle.entry.search.mode | required | SearchEntryMode | ||||
Bundle.entry.request.method | required | HTTPVerb |
This structure is derived from Bundle
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Bundle | Contains a collection of resources | |
![]() ![]() ![]() | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: transaction-response | |
![]() ![]() ![]() | 1..* | BackboneElement | One entry for each entry in the request, in the same order as received | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Indicating the results of processing the entry | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The location (if the operation returns a location) | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Bundle | Contains a collection of resources |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | Σ | 1..1 | code | document | 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. Required Pattern: transaction-response |
![]() ![]() ![]() | ΣC | 1..* | BackboneElement | One entry for each entry in the request, in the same order as received 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 |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Indicating the results of processing the entry |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The location (if the operation returns a location) |
![]() |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Pattern: transaction-response |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | C | 0..* | Bundle | Contains a collection of resources | ||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() | Σ | 1..1 | code | document | 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. Required Pattern: transaction-response | ||||
![]() ![]() ![]() | Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]() ![]() | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() ![]() | ΣC | 1..* | BackboneElement | One entry for each entry in the request, in the same order as received 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | match | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Indicating the results of processing the entry | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() | ΣTU | 0..1 | Signature | Digital Signature | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
Bundle.language | preferred | CommonLanguages
| ||||
Bundle.type | required | Pattern: transaction-response | ||||
Bundle.entry.search.mode | required | SearchEntryMode | ||||
Bundle.entry.request.method | required | HTTPVerb |
This structure is derived from Bundle
Other representations of profile: CSV, Excel, Schematron