Guías de Implementación HL7 FHIR: CR Core
0.1.1-draft - ci-build
Guías de Implementación HL7 FHIR: CR Core, published by Ministerio de Salud de Costa Rica. This guide is not an authorized publication; it is the continuous build for version 0.1.1-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HIE-cr/core-ig/ and changes regularly. See the Directory of published versions
Official URL: https://ministeriodesalud.go.cr/fhir/core/StructureDefinition/bundle-cr-core | Version: 0.1.1-draft | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: BundleCrCore | ||
Copyright/Legal: Usado con el permiso de HL7 International, todos los derechos resevados en los Licencias de HL7 Internacional. |
Perfil CORE de Paquete de Recursos (Bundle) con soporte para firma digital GAUDI
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | 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 |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Etiqueta de seguridad Binding: Etiquetas de seguridad (required) |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
SΣC | 1..1 | code | Tipo de recurso Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. |
![]() ![]() ![]() |
SΣC | 0..1 | instant | Fecha y hora de creación del paquete |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entradas del paquete 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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 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 |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() |
SΣ | 1..1 | Signature | Firma digital del paquete |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Tipo de firma Binding: SignatureTypeCodes (required) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Rol de Profesional de la Salud | Organizaciones) | Quien firma el paquete |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Firma digital GAUDI en base64 |
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
![]() |
Path | Conformance | ValueSet | URI |
Bundle.meta.security | required | SecurityLabelhttps://ministeriodesalud.go.cr/fhir/core/ValueSet/security-label From this IG | |
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.signature.type | required | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-type From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Etiqueta de seguridad Binding: Etiquetas de seguridad (required) |
![]() ![]() ![]() |
S | 1..1 | code | Tipo de recurso |
![]() ![]() ![]() |
S | 0..1 | instant | Fecha y hora de creación del paquete |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entradas del paquete |
![]() ![]() ![]() |
S | 1..1 | Signature | Firma digital del paquete |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Tipo de firma Binding: SignatureTypeCodes (required) |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Rol de Profesional de la Salud | Organizaciones) | Quien firma el paquete |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Firma digital GAUDI en base64 |
![]() |
Path | Conformance | ValueSet | URI |
Bundle.meta.security | required | SecurityLabelhttps://ministeriodesalud.go.cr/fhir/core/ValueSet/security-label From this IG | |
Bundle.signature.type | required | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-type From the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Etiqueta de seguridad Binding: Etiquetas de seguridad (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
SΣC | 1..1 | code | Tipo de recurso Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. | ||||
![]() ![]() ![]() |
SΣC | 0..1 | instant | Fecha y hora de creación del paquete | ||||
![]() ![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() |
ΣC | 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 | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required) | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | Reference details for the link | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entradas del paquete 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 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
ΣC | 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 - 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 | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 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 validation | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Signature | Firma digital del paquete | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Tipo de firma Binding: SignatureTypeCodes (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the signature was created | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Rol de Profesional de la Salud | Organizaciones) | Quien firma el paquete | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||
![]() ![]() ![]() ![]() |
0..1 | code | The technical format of the signed resources Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | The technical format of the signature Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Firma digital GAUDI en base64 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle | ||||
![]() |
Path | Conformance | ValueSet | URI |
Bundle.meta.security | required | SecurityLabelhttps://ministeriodesalud.go.cr/fhir/core/ValueSet/security-label From this IG | |
Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | |
Bundle.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.link.relation | required | LinkRelationTypeshttp://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0 From the FHIR Standard | |
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.signature.type | required | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-type From the FHIR Standard | |
Bundle.signature.targetFormat | required | MimeTypes(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
Bundle.signature.sigFormat | required | MimeTypes(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Maturity: 0
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | 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 |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Etiqueta de seguridad Binding: Etiquetas de seguridad (required) |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
SΣC | 1..1 | code | Tipo de recurso Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. |
![]() ![]() ![]() |
SΣC | 0..1 | instant | Fecha y hora de creación del paquete |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entradas del paquete 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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 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 |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() |
SΣ | 1..1 | Signature | Firma digital del paquete |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Tipo de firma Binding: SignatureTypeCodes (required) |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Rol de Profesional de la Salud | Organizaciones) | Quien firma el paquete |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Firma digital GAUDI en base64 |
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
![]() |
Path | Conformance | ValueSet | URI |
Bundle.meta.security | required | SecurityLabelhttps://ministeriodesalud.go.cr/fhir/core/ValueSet/security-label From this IG | |
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.signature.type | required | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-type From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Etiqueta de seguridad Binding: Etiquetas de seguridad (required) |
![]() ![]() ![]() |
S | 1..1 | code | Tipo de recurso |
![]() ![]() ![]() |
S | 0..1 | instant | Fecha y hora de creación del paquete |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entradas del paquete |
![]() ![]() ![]() |
S | 1..1 | Signature | Firma digital del paquete |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Tipo de firma Binding: SignatureTypeCodes (required) |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Rol de Profesional de la Salud | Organizaciones) | Quien firma el paquete |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Firma digital GAUDI en base64 |
![]() |
Path | Conformance | ValueSet | URI |
Bundle.meta.security | required | SecurityLabelhttps://ministeriodesalud.go.cr/fhir/core/ValueSet/security-label From this IG | |
Bundle.signature.type | required | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-type From the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Etiqueta de seguridad Binding: Etiquetas de seguridad (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
SΣC | 1..1 | code | Tipo de recurso Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. | ||||
![]() ![]() ![]() |
SΣC | 0..1 | instant | Fecha y hora de creación del paquete | ||||
![]() ![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() |
ΣC | 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 | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required) | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | Reference details for the link | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entradas del paquete 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 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
ΣC | 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 - 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 | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 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 validation | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Signature | Firma digital del paquete | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Tipo de firma Binding: SignatureTypeCodes (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the signature was created | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Rol de Profesional de la Salud | Organizaciones) | Quien firma el paquete | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||
![]() ![]() ![]() ![]() |
0..1 | code | The technical format of the signed resources Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | The technical format of the signature Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Firma digital GAUDI en base64 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle | ||||
![]() |
Path | Conformance | ValueSet | URI |
Bundle.meta.security | required | SecurityLabelhttps://ministeriodesalud.go.cr/fhir/core/ValueSet/security-label From this IG | |
Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | |
Bundle.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.link.relation | required | LinkRelationTypeshttp://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0 From the FHIR Standard | |
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.signature.type | required | SignatureTypeCodeshttp://hl7.org/fhir/ValueSet/signature-type From the FHIR Standard | |
Bundle.signature.targetFormat | required | MimeTypes(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
Bundle.signature.sigFormat | required | MimeTypes(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron