Non-patient File Sharing (NPFS)
2.2.0 - Trial-Implementation
This page is part of the Non-patient File Sharing (NPFS) (v2.2.0: Publication) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.ReplaceDocumentBundle | Version: 2.2.0 | |||
Active as of 2023-11-16 | Computable Name: NPFSReplaceDocumentBundle |
A profile on the Bundle transaction for ITI-87 Submit File used to replace a file and related metadata
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 | |
![]() ![]() ![]() | S | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | the DocumentReference resource with metadata of the new file | |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | the DocumentReference resource with metadata of the previous file | |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: PUT | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | the Document | |
![]() ![]() ![]() ![]() ![]() | 1..1 | Binary | Pure binary content defined by a format other than FHIR | |
![]() ![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() |
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 |
![]() ![]() ![]() | SΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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 |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the new file 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 |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. Required Pattern: POST |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the previous file 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 |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. Required Pattern: PUT |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the Document 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 |
![]() ![]() ![]() ![]() ![]() | 1..1 | Binary | Pure binary content defined by a format other than FHIR | |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. Required Pattern: POST |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Pattern: transaction |
Bundle.entry:NewDocumenReference.request.method | required | Pattern: POST |
Bundle.entry:OldDocumenReference.request.method | required | Pattern: PUT |
Bundle.entry:Documents.request.method | required | Pattern: POST |
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 | ||||
![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() | SΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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 | ||||
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() | 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) | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the new file 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) | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |||||
![]() ![]() ![]() ![]() ![]() | Σ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 | 1..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. Required Pattern: POST | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the previous file 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) | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |||||
![]() ![]() ![]() ![]() ![]() | Σ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 | 1..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. Required Pattern: PUT | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the Document 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) | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | Binary | Pure binary content defined by a format other than FHIR | |||||
![]() ![]() ![]() ![]() ![]() | Σ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 | 1..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. Required Pattern: POST | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() | Σ | 0..1 | Signature | Digital Signature | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
Bundle.language | preferred | CommonLanguages
| ||||
Bundle.type | required | Pattern: transaction | ||||
Bundle.entry.search.mode | required | SearchEntryMode | ||||
Bundle.entry.request.method | required | HTTPVerb | ||||
Bundle.entry:NewDocumenReference.search.mode | required | SearchEntryMode | ||||
Bundle.entry:NewDocumenReference.request.method | required | Pattern: POST | ||||
Bundle.entry:OldDocumenReference.search.mode | required | SearchEntryMode | ||||
Bundle.entry:OldDocumenReference.request.method | required | Pattern: PUT | ||||
Bundle.entry:Documents.search.mode | required | SearchEntryMode | ||||
Bundle.entry:Documents.request.method | required | Pattern: POST |
This structure is derived from Bundle
Summary
Mandatory: 9 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
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 | |
![]() ![]() ![]() | S | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | the DocumentReference resource with metadata of the new file | |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | the DocumentReference resource with metadata of the previous file | |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: PUT | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | the Document | |
![]() ![]() ![]() ![]() ![]() | 1..1 | Binary | Pure binary content defined by a format other than FHIR | |
![]() ![]() ![]() ![]() ![]() | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() |
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 |
![]() ![]() ![]() | SΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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 |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the new file 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 |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. Required Pattern: POST |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the previous file 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 |
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. Required Pattern: PUT |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the Document 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 |
![]() ![]() ![]() ![]() ![]() | 1..1 | Binary | Pure binary content defined by a format other than FHIR | |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. Required Pattern: POST |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Pattern: transaction |
Bundle.entry:NewDocumenReference.request.method | required | Pattern: POST |
Bundle.entry:OldDocumenReference.request.method | required | Pattern: PUT |
Bundle.entry:Documents.request.method | required | Pattern: POST |
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 | ||||
![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() | SΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource, value:request.method 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 | ||||
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() | 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) | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the new file 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) | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |||||
![]() ![]() ![]() ![]() ![]() | Σ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 | 1..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. Required Pattern: POST | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the DocumentReference resource with metadata of the previous file 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) | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | NPFSDocumentReference | A reference to a document | |||||
![]() ![]() ![]() ![]() ![]() | Σ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 | 1..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. Required Pattern: PUT | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() ![]() | ΣC | 1..1 | BackboneElement | the Document 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) | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | Binary | Pure binary content defined by a format other than FHIR | |||||
![]() ![]() ![]() ![]() ![]() | Σ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 | 1..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. Required Pattern: POST | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | 0..1 | BackboneElement | Results of execution (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 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..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) | ||||
![]() ![]() ![]() | Σ | 0..1 | Signature | Digital Signature | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
Bundle.language | preferred | CommonLanguages
| ||||
Bundle.type | required | Pattern: transaction | ||||
Bundle.entry.search.mode | required | SearchEntryMode | ||||
Bundle.entry.request.method | required | HTTPVerb | ||||
Bundle.entry:NewDocumenReference.search.mode | required | SearchEntryMode | ||||
Bundle.entry:NewDocumenReference.request.method | required | Pattern: POST | ||||
Bundle.entry:OldDocumenReference.search.mode | required | SearchEntryMode | ||||
Bundle.entry:OldDocumenReference.request.method | required | Pattern: PUT | ||||
Bundle.entry:Documents.search.mode | required | SearchEntryMode | ||||
Bundle.entry:Documents.request.method | required | Pattern: POST |
This structure is derived from Bundle
Summary
Mandatory: 9 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron