This is the set of resources that conform to both DDCC Provide Document Bundle (http://smart.who.int/ddcc/StructureDefinition/DDCCProvideDocumentBundle) and DDCC Provide Document Bundle (http://smart.who.int/ddcc/StructureDefinition/DDCCProvideDocumentBundle).
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource | |||||
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
versionId | Σ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from ele-1: All FHIR elements must have a @value or children | ||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used. ele-1: All FHIR elements must have a @value or children | ||||
timestamp | Σ | 0..1 | instant | When the bundle was assembled ele-1: All FHIR elements must have a @value or children | ||||
total | Σ | 0..1 | unsignedInt | If search, the total number of matches ele-1: All FHIR elements must have a @value or children | ||||
link | Σ | 0..* | BackboneElement | Links related to this Bundle ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 ele-1: All FHIR elements must have a @value or children | ||||
url | Σ | 1..1 | uri | Reference details for the link ele-1: All FHIR elements must have a @value or children | ||||
entry | SΣC | 1..* | 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 ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
link | Σ | 0..* | Links related to this entry ele-1: All FHIR elements must have a @value or children | |||||
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) ele-1: All FHIR elements must have a @value or children | ||||
resource | SΣ | 0..1 | Resource | A resource in the bundle | ||||
search | Σ | 0..1 | BackboneElement | Search related information ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: ?? (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. ele-1: All FHIR elements must have a @value or children | ||||
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) ele-1: All FHIR elements must have a @value or children | ||||
request | Σ | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See [HTTP rfc] for details. ele-1: All FHIR elements must have a @value or children | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry ele-1: All FHIR elements must have a @value or children | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency ele-1: All FHIR elements must have a @value or children | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency ele-1: All FHIR elements must have a @value or children | ||||
ifMatch | Σ | 0..1 | string | For managing update contention ele-1: All FHIR elements must have a @value or children | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates ele-1: All FHIR elements must have a @value or children | ||||
response | Σ | 0..1 | BackboneElement | Results of execution (transaction/batch/history) ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
status | Σ | 1..1 | string | Status response code (text optional) ele-1: All FHIR elements must have a @value or children | ||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) ele-1: All FHIR elements must have a @value or children | ||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) ele-1: All FHIR elements must have a @value or children | ||||
lastModified | Σ | 0..1 | instant | Server's date time modified ele-1: All FHIR elements must have a @value or children | ||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
signature | Σ | 0..1 | Signature | Digital Signature ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |