NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.
StructureDefinition-DocumentBundle
This profile sets minimum expectations for the DocumentBundle that includes all resources into a single instance with containing context to act as an exchangeable clinical document. It identifies the mandatory core elements, vocabularies and value sets which SHALL be present in the Composition resource when using this profile.
Examples
- Bundle-DiagnosticReport-Imaging-DCM-example-01
- Bundle-DiagnosticReport-Imaging-Media-example-02
- Bundle-DiagnosticReport-Lab-example-03
- Bundle-DischargeSummary-example-04
- Bundle-OPConsultNote-example-05
- Bundle-Prescription-example-06
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is:
https://nrces.in/ndhm/fhir/r4/StructureDefinition/DocumentBundle
This profile builds on Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  meta | 1..1 | Meta | Metadata about the resource | |
 versionId | 1..1 | id | Version specific identifier | |
 security | S | 0..* | Coding | Security Labels applied to this resource |
| identifier | 1..1 | Identifier | Persistent identifier for the bundle | |
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| timestamp | 1..1 | instant | When the bundle was assembled | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
 extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| versionId | ΣI | 1..1 | id | Version specific identifier |
| lastUpdated | ΣI | 0..1 | instant | When the resource version last changed |
| source | ΣI | 0..1 | uri | Identifies where the resource comes from |
| profile | ΣI | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | SΣI | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | ΣI | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| identifier | ΣI | 1..1 | Identifier | Persistent identifier for the bundle |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 1..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
 assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| type | ΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) |
| timestamp | ΣI | 1..1 | instant | When the bundle was assembled |
| total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
| link | ΣI | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relation | ΣI | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
| url | ΣI | 1..1 | uri | Reference details for the link |
| entry | ΣI | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | ΣI | 0..* | See link | Links related to this entry |
| fullUrl | ΣI | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | Σ | 0..1 | Resource | A resource in the bundle |
| search | ΣI | 0..1 | BackboneElement | Search related information |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| score | ΣI | 0..1 | decimal | Search ranking (between 0 and 1) |
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
| url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
| ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
| ifMatch | ΣI | 0..1 | string | For managing update contention |
| ifNoneExist | ΣI | 0..1 | string | For conditional creates |
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | ΣI | 1..1 | string | Status response code (text optional) |
| location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
| etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | ΣI | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| signature | ΣI | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| meta | 1..1 | Meta | Metadata about the resource | |
| versionId | 1..1 | id | Version specific identifier | |
| security | S | 0..* | Coding | Security Labels applied to this resource |
| identifier | 1..1 | Identifier | Persistent identifier for the bundle | |
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| timestamp | 1..1 | instant | When the bundle was assembled | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| versionId | ΣI | 1..1 | id | Version specific identifier |
| lastUpdated | ΣI | 0..1 | instant | When the resource version last changed |
| source | ΣI | 0..1 | uri | Identifies where the resource comes from |
| profile | ΣI | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | SΣI | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | ΣI | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| identifier | ΣI | 1..1 | Identifier | Persistent identifier for the bundle |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 1..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| type | ΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) |
| timestamp | ΣI | 1..1 | instant | When the bundle was assembled |
| total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
| link | ΣI | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relation | ΣI | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
| url | ΣI | 1..1 | uri | Reference details for the link |
| entry | ΣI | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | ΣI | 0..* | See link | Links related to this entry |
| fullUrl | ΣI | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | Σ | 0..1 | Resource | A resource in the bundle |
| search | ΣI | 0..1 | BackboneElement | Search related information |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| score | ΣI | 0..1 | decimal | Search ranking (between 0 and 1) |
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
| url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
| ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
| ifMatch | ΣI | 0..1 | string | For managing update contention |
| ifNoneExist | ΣI | 0..1 | string | For conditional creates |
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | ΣI | 1..1 | string | Status response code (text optional) |
| location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
| etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | ΣI | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| signature | ΣI | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
