HL7 FHIR Costa Rica - Resultados de Laboratorio
0.0.1-draft - ci-build Costa Rica flag

HL7 FHIR Costa Rica - Resultados de Laboratorio, published by Iniciativa HL7 Costa Rica. This guide is not an authorized publication; it is the continuous build for version 0.0.1-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cr/laboratory-results/ and changes regularly. See the Directory of published versions

Resource Profile: Bundle de Resultados de Laboratorio

Official URL: https://hl7.or.cr/fhir/laboratory-results/StructureDefinition/cr-lab-result-bundle Version: 0.0.1
Standards status: Draft Maturity Level: 0 Computable Name: CRLabResultBundle

Copyright/Legal: Utilizado con permiso de HL7 International, todos los derechos reservados Licencia Creative Commons

Perfil FHIR Bundle para intercambiar resultados de laboratorio con capacidad de firma digital JAdES. Este Bundle contiene observaciones de laboratorio que pueden ser firmadas digitalmente para garantizar autenticidad e integridad.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(5.0.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type ΣC 1..1 code Tipo de Bundle
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣC 1..1 instant Fecha y hora del Bundle
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... fullUrl SΣC 1..1 uri URL única del recurso
.... resource SΣC 1..1 Resource Recursos contenidos en el Bundle
.... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... method SΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url SΣ 1..1 uri URL for HTTP equivalent of this entry
.... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... status Σ 1..1 string Status response code (text optional)
... signature SΣ 0..1 Signature Firma digital del Bundle
.... type SΣ 1..1 Coding Tipo de firma
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant Cuándo se firmó
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Quién firmó
.... data S 1..1 base64Binary Datos de la firma
... issues ΣC 0..1 OperationOutcome(5.0.0) Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error Bundle.implicitRules, Bundle.type, Bundle.timestamp, Bundle.entry, Bundle.entry.modifierExtension, Bundle.entry.fullUrl, Bundle.entry.request, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.response, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.signature, Bundle.signature.type, Bundle.signature.when, Bundle.signature.who, Bundle.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Bundle.entry.modifierExtension, Bundle.entry.request.modifierExtension, Bundle.entry.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle(5.0.0) Contains a collection of resources
... type 1..1 code Tipo de Bundle
Fixed Value: document
... timestamp S 1..1 instant Fecha y hora del Bundle
... entry S 1..* BackboneElement Entry in the bundle - will have a resource or information
.... fullUrl S 1..1 uri URL única del recurso
.... resource S 1..1 Resource Recursos contenidos en el Bundle
.... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... method S 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url S 1..1 uri URL for HTTP equivalent of this entry
.... type S 1..1 Coding Tipo de firma
.... when S 1..1 instant Cuándo se firmó
.... who S 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Quién firmó
.... data S 1..1 base64Binary Datos de la firma

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(5.0.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier ΣC 0..1 Identifier Persistent identifier for the bundle
... type ΣC 1..1 code Tipo de Bundle
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣC 1..1 instant Fecha y hora del Bundle
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link ΣC 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... relation ΣC 1..1 code See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: LinkRelationTypes (required)
.... url ΣC 1..1 uri Reference details for the link
... entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl SΣC 1..1 uri URL única del recurso
.... resource SΣC 1..1 Resource Recursos contenidos en el Bundle
.... search ΣC 0..1 BackboneElement Search related information
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... mode Σ 0..1 code match | include - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... method SΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url SΣ 1..1 uri URL for HTTP equivalent of this entry
..... ifNoneMatch Σ 0..1 string For managing cache validation
..... ifModifiedSince Σ 0..1 instant For managing cache currency
..... ifMatch Σ 0..1 string For managing update contention
..... ifNoneExist Σ 0..1 string For conditional creates
.... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... status Σ 1..1 string Status response code (text optional)
..... location Σ 0..1 uri The location (if the operation returns a location)
..... etag Σ 0..1 string The Etag for the resource (if relevant)
..... lastModified Σ 0..1 instant Server's date time modified
..... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature SΣ 0..1 Signature Firma digital del Bundle
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... type SΣ 1..1 Coding Tipo de firma
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant Cuándo se firmó
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Quién firmó
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... sigFormat 0..1 code The technical format of the signature
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... data S 1..1 base64Binary Datos de la firma
... issues ΣC 0..1 OperationOutcome(5.0.0) Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.search.​mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍5.0.0 FHIR Std.
Bundle.signature.targetFormat Base required Mime Types 📍5.0.0 FHIR Std.
Bundle.signature.sigFormat Base required Mime Types 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error Bundle.meta, Bundle.implicitRules, Bundle.language, Bundle.identifier, Bundle.type, Bundle.timestamp, Bundle.total, Bundle.link, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.link.relation, Bundle.link.url, Bundle.entry, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.link, Bundle.entry.fullUrl, Bundle.entry.search, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.search.mode, Bundle.entry.search.score, Bundle.entry.request, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.request.ifNoneMatch, Bundle.entry.request.ifModifiedSince, Bundle.entry.request.ifMatch, Bundle.entry.request.ifNoneExist, Bundle.entry.response, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.entry.response.location, Bundle.entry.response.etag, Bundle.entry.response.lastModified, Bundle.signature, Bundle.signature.extension, Bundle.signature.type, Bundle.signature.when, Bundle.signature.who, Bundle.signature.onBehalfOf, Bundle.signature.targetFormat, Bundle.signature.sigFormat, Bundle.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Bundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.signature.extension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 12 elements
Fixed: 1 element

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(5.0.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type ΣC 1..1 code Tipo de Bundle
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣC 1..1 instant Fecha y hora del Bundle
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... fullUrl SΣC 1..1 uri URL única del recurso
.... resource SΣC 1..1 Resource Recursos contenidos en el Bundle
.... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... method SΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url SΣ 1..1 uri URL for HTTP equivalent of this entry
.... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... status Σ 1..1 string Status response code (text optional)
... signature SΣ 0..1 Signature Firma digital del Bundle
.... type SΣ 1..1 Coding Tipo de firma
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant Cuándo se firmó
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Quién firmó
.... data S 1..1 base64Binary Datos de la firma
... issues ΣC 0..1 OperationOutcome(5.0.0) Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error Bundle.implicitRules, Bundle.type, Bundle.timestamp, Bundle.entry, Bundle.entry.modifierExtension, Bundle.entry.fullUrl, Bundle.entry.request, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.response, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.signature, Bundle.signature.type, Bundle.signature.when, Bundle.signature.who, Bundle.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Bundle.entry.modifierExtension, Bundle.entry.request.modifierExtension, Bundle.entry.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle(5.0.0) Contains a collection of resources
... type 1..1 code Tipo de Bundle
Fixed Value: document
... timestamp S 1..1 instant Fecha y hora del Bundle
... entry S 1..* BackboneElement Entry in the bundle - will have a resource or information
.... fullUrl S 1..1 uri URL única del recurso
.... resource S 1..1 Resource Recursos contenidos en el Bundle
.... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... method S 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url S 1..1 uri URL for HTTP equivalent of this entry
.... type S 1..1 Coding Tipo de firma
.... when S 1..1 instant Cuándo se firmó
.... who S 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Quién firmó
.... data S 1..1 base64Binary Datos de la firma

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(5.0.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier ΣC 0..1 Identifier Persistent identifier for the bundle
... type ΣC 1..1 code Tipo de Bundle
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣC 1..1 instant Fecha y hora del Bundle
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link ΣC 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... relation ΣC 1..1 code See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: LinkRelationTypes (required)
.... url ΣC 1..1 uri Reference details for the link
... entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl SΣC 1..1 uri URL única del recurso
.... resource SΣC 1..1 Resource Recursos contenidos en el Bundle
.... search ΣC 0..1 BackboneElement Search related information
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... mode Σ 0..1 code match | include - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... method SΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
..... url SΣ 1..1 uri URL for HTTP equivalent of this entry
..... ifNoneMatch Σ 0..1 string For managing cache validation
..... ifModifiedSince Σ 0..1 instant For managing cache currency
..... ifMatch Σ 0..1 string For managing update contention
..... ifNoneExist Σ 0..1 string For conditional creates
.... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... status Σ 1..1 string Status response code (text optional)
..... location Σ 0..1 uri The location (if the operation returns a location)
..... etag Σ 0..1 string The Etag for the resource (if relevant)
..... lastModified Σ 0..1 instant Server's date time modified
..... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature SΣ 0..1 Signature Firma digital del Bundle
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... type SΣ 1..1 Coding Tipo de firma
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant Cuándo se firmó
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Quién firmó
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... sigFormat 0..1 code The technical format of the signature
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... data S 1..1 base64Binary Datos de la firma
... issues ΣC 0..1 OperationOutcome(5.0.0) Issues with the Bundle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base required All Languages 📍5.0.0 FHIR Std.
Bundle.type Base required Bundle Type 📍5.0.0 FHIR Std.
Bundle.link.relation Base required Link Relation Types 📍5.0.0 FHIR Std.
Bundle.entry.search.​mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry.request.​method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍5.0.0 FHIR Std.
Bundle.signature.targetFormat Base required Mime Types 📍5.0.0 FHIR Std.
Bundle.signature.sigFormat Base required Mime Types 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search (type = 'searchset') or entry.search.empty()
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-13 error Bundle A subscription-notification must have a SubscriptionStatus as the first resource type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14 error Bundle entry.request.method PATCH not allowed for history type = 'history' implies entry.request.method != 'PATCH'
bdl-15 error Bundle Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16 error Bundle Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17 error Bundle Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. type = 'document' implies issues.empty()
bdl-18 error Bundle Self link is required for searchsets. type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3a error Bundle For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b error Bundle For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c error Bundle For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d error Bundle For collections of type transaction-response or batch-response, all entries must contain response elements type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
ele-1 error Bundle.meta, Bundle.implicitRules, Bundle.language, Bundle.identifier, Bundle.type, Bundle.timestamp, Bundle.total, Bundle.link, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.link.relation, Bundle.link.url, Bundle.entry, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.link, Bundle.entry.fullUrl, Bundle.entry.search, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.search.mode, Bundle.entry.search.score, Bundle.entry.request, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.request.ifNoneMatch, Bundle.entry.request.ifModifiedSince, Bundle.entry.request.ifMatch, Bundle.entry.request.ifNoneExist, Bundle.entry.response, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.entry.response.location, Bundle.entry.response.etag, Bundle.entry.response.lastModified, Bundle.signature, Bundle.signature.extension, Bundle.signature.type, Bundle.signature.when, Bundle.signature.who, Bundle.signature.onBehalfOf, Bundle.signature.targetFormat, Bundle.signature.sigFormat, Bundle.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Bundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.signature.extension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 12 elements
Fixed: 1 element

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron