This page is part of the CH-CRL (R4) (v0.2.0: STU Draft) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

StructureDefinition: ch-crl-bundle

Formal Views of Profile Content

The official URL for this profile is:

http://fhir.ch/ig/ch-crl/StructureDefinition/ch-crl-bundle

Definition of the bundle for reporting to the cancer registry

This profile builds on CHCoreDocument.

This profile was published on Fri Nov 08 00:00:00 CET 2019 as a draft by Bundesamt für Gesundheit BAG.

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

 

Terminology Bindings

Path	Conformance	ValueSet / Code
Bundle.language	preferred	CommonLanguages Max Binding: AllLanguages
Bundle.identifier.use	required	IdentifierUse
Bundle.identifier.type	extensible	Identifier Type Codes
Bundle.type	required	Fixed Value: document
Bundle.entry.search.mode	required	SearchEntryMode
Bundle.entry.request.method	required	HTTPVerb
Bundle.entry:Composition.search.mode	required	SearchEntryMode
Bundle.entry:Composition.request.method	required	HTTPVerb

Constraints

Id	Path	Details	Requirements
bdl-1	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-7	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&resource.meta.versionId).isDistinct()
bdl-9	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	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	Bundle.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.timestamp	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.total	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.link	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.link.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.link.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.link.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.link.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.link.relation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.link.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
bdl-5	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-8	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
ele-1	Bundle.entry	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.link	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.fullUrl	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
dom-2	Bundle.entry.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Bundle.entry.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	Bundle.entry.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	Bundle.entry.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Bundle.entry.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Bundle.entry.search	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.search.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.search.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.search.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.search.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.search.mode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.search.score	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.request.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.request.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.request.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.request.method	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifNoneMatch	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifModifiedSince	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifMatch	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifNoneExist	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.response.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.response.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.response.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.response.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.etag	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.lastModified	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
bdl-5	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-8	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
ele-1	Bundle.entry	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.link	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.fullUrl	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
dom-2	Bundle.entry.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Bundle.entry.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	Bundle.entry.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	Bundle.entry.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Bundle.entry.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Bundle.entry.search	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.search.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.search.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.search.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.search.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.search.mode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.search.score	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.request.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.request.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.request.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.request.method	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifNoneMatch	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifModifiedSince	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifMatch	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.request.ifNoneExist	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.response.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.response.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Bundle.entry.response.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Bundle.entry.response.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.etag	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.entry.response.lastModified	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Bundle.signature	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

.