CH EPR FHIR (R4)
4.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.0-ballot: DSTU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH PPQm Feed Request Bundle

Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmFeedRequestBundle Version: 4.0.0-ballot
Active as of 2024-05-16 Computable Name: PpqmFeedRequestBundle

Copyright/Legal: CC0-1.0

Bundle for Mobile Privacy Policy Bundle Feed requests

Usage:

Formal Views of Profile Content

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

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
ch-epr-ppqm-method-equality: HTTP methods of all request shall be the same
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: transaction
... entry C 1..* BackboneElement Entry in the bundle - will have a resource or information
ch-epr-ppqm-constistent-ids: For PUT, policy set ID in the embedded resource shall be the same as in the entry URL
.... resource 0..1 PpqmConsent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
.... request C 0..1 BackboneElement Additional execution information (transaction/batch/history)
ch-epr-ppqm-url-format: URL format shall suit the HTTP method
..... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: CH PPQm Feed Request HTTP Method (required)
..... ifNoneMatch 0..0
..... ifModifiedSince 0..0
..... ifMatch 0..0
..... ifNoneExist 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.entry.request.methodrequiredPpqmFeedRequestHttpMethod
http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmFeedRequestHttpMethod
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ch-epr-ppqm-constistent-idserrorBundle.entryFor PUT, policy set ID in the embedded resource shall be the same as in the entry URL
: (request.method != 'PUT') or (resource.identifier.where( type.coding.exists((system = 'http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType') and (code = 'policySetId')) ).value.lower() = request.url.substring(19).lower())
ch-epr-ppqm-method-equalityerrorBundleHTTP methods of all request shall be the same
: entry.request.method.distinct().count() = 1
ch-epr-ppqm-url-formaterrorBundle.entry.requestURL format shall suit the HTTP method
: ( (method = 'POST') and (url = 'Consent') ) or ( (method != 'POST') and url.startsWith('Consent?identifier=') and url.lower().matches('^consent\\?identifier=urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$') )
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
ch-epr-ppqm-method-equality: HTTP methods of all request shall be the same
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: transaction
... entry ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ch-epr-ppqm-constistent-ids: For PUT, policy set ID in the embedded resource shall be the same as in the entry URL
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource 0..1 PpqmConsent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
.... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
ch-epr-ppqm-url-format: URL format shall suit the HTTP method
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: CH PPQm Feed Request HTTP Method (required)
..... url Σ 1..1 uri URL for HTTP equivalent of this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredPpqmFeedRequestHttpMethod
http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmFeedRequestHttpMethod
from this IG

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ch-epr-ppqm-constistent-idserrorBundle.entryFor PUT, policy set ID in the embedded resource shall be the same as in the entry URL
: (request.method != 'PUT') or (resource.identifier.where( type.coding.exists((system = 'http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType') and (code = 'policySetId')) ).value.lower() = request.url.substring(19).lower())
ch-epr-ppqm-method-equalityerrorBundleHTTP methods of all request shall be the same
: entry.request.method.distinct().count() = 1
ch-epr-ppqm-url-formaterrorBundle.entry.requestURL format shall suit the HTTP method
: ( (method = 'POST') and (url = 'Consent') ) or ( (method != 'POST') and url.startsWith('Consent?identifier=') and url.lower().matches('^consent\\?identifier=urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$') )
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
ch-epr-ppqm-method-equality: HTTP methods of all request shall be the same
... 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 Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... entry ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ch-epr-ppqm-constistent-ids: For PUT, policy set ID in the embedded resource shall be the same as in the entry URL
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource 0..1 PpqmConsent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
ch-epr-ppqm-url-format: URL format shall suit the HTTP method
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: CH PPQm Feed Request HTTP Method (required)
..... url Σ 1..1 uri URL for HTTP equivalent of this entry
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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 Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredPpqmFeedRequestHttpMethod
http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmFeedRequestHttpMethod
from this IG

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ch-epr-ppqm-constistent-idserrorBundle.entryFor PUT, policy set ID in the embedded resource shall be the same as in the entry URL
: (request.method != 'PUT') or (resource.identifier.where( type.coding.exists((system = 'http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType') and (code = 'policySetId')) ).value.lower() = request.url.substring(19).lower())
ch-epr-ppqm-method-equalityerrorBundleHTTP methods of all request shall be the same
: entry.request.method.distinct().count() = 1
ch-epr-ppqm-url-formaterrorBundle.entry.requestURL format shall suit the HTTP method
: ( (method = 'POST') and (url = 'Consent') ) or ( (method != 'POST') and url.startsWith('Consent?identifier=') and url.lower().matches('^consent\\?identifier=urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$') )
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
ch-epr-ppqm-method-equality: HTTP methods of all request shall be the same
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: transaction
... entry C 1..* BackboneElement Entry in the bundle - will have a resource or information
ch-epr-ppqm-constistent-ids: For PUT, policy set ID in the embedded resource shall be the same as in the entry URL
.... resource 0..1 PpqmConsent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
.... request C 0..1 BackboneElement Additional execution information (transaction/batch/history)
ch-epr-ppqm-url-format: URL format shall suit the HTTP method
..... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: CH PPQm Feed Request HTTP Method (required)
..... ifNoneMatch 0..0
..... ifModifiedSince 0..0
..... ifMatch 0..0
..... ifNoneExist 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.entry.request.methodrequiredPpqmFeedRequestHttpMethod
http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmFeedRequestHttpMethod
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ch-epr-ppqm-constistent-idserrorBundle.entryFor PUT, policy set ID in the embedded resource shall be the same as in the entry URL
: (request.method != 'PUT') or (resource.identifier.where( type.coding.exists((system = 'http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType') and (code = 'policySetId')) ).value.lower() = request.url.substring(19).lower())
ch-epr-ppqm-method-equalityerrorBundleHTTP methods of all request shall be the same
: entry.request.method.distinct().count() = 1
ch-epr-ppqm-url-formaterrorBundle.entry.requestURL format shall suit the HTTP method
: ( (method = 'POST') and (url = 'Consent') ) or ( (method != 'POST') and url.startsWith('Consent?identifier=') and url.lower().matches('^consent\\?identifier=urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$') )

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
ch-epr-ppqm-method-equality: HTTP methods of all request shall be the same
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: transaction
... entry ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ch-epr-ppqm-constistent-ids: For PUT, policy set ID in the embedded resource shall be the same as in the entry URL
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource 0..1 PpqmConsent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
.... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
ch-epr-ppqm-url-format: URL format shall suit the HTTP method
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: CH PPQm Feed Request HTTP Method (required)
..... url Σ 1..1 uri URL for HTTP equivalent of this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredPpqmFeedRequestHttpMethod
http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmFeedRequestHttpMethod
from this IG

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ch-epr-ppqm-constistent-idserrorBundle.entryFor PUT, policy set ID in the embedded resource shall be the same as in the entry URL
: (request.method != 'PUT') or (resource.identifier.where( type.coding.exists((system = 'http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType') and (code = 'policySetId')) ).value.lower() = request.url.substring(19).lower())
ch-epr-ppqm-method-equalityerrorBundleHTTP methods of all request shall be the same
: entry.request.method.distinct().count() = 1
ch-epr-ppqm-url-formaterrorBundle.entry.requestURL format shall suit the HTTP method
: ( (method = 'POST') and (url = 'Consent') ) or ( (method != 'POST') and url.startsWith('Consent?identifier=') and url.lower().matches('^consent\\?identifier=urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$') )
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
ch-epr-ppqm-method-equality: HTTP methods of all request shall be the same
... 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 Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... entry ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ch-epr-ppqm-constistent-ids: For PUT, policy set ID in the embedded resource shall be the same as in the entry URL
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource 0..1 PpqmConsent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
ch-epr-ppqm-url-format: URL format shall suit the HTTP method
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: CH PPQm Feed Request HTTP Method (required)
..... url Σ 1..1 uri URL for HTTP equivalent of this entry
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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 Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredPpqmFeedRequestHttpMethod
http://fhir.ch/ig/ch-epr-fhir/ValueSet/PpqmFeedRequestHttpMethod
from this IG

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ch-epr-ppqm-constistent-idserrorBundle.entryFor PUT, policy set ID in the embedded resource shall be the same as in the entry URL
: (request.method != 'PUT') or (resource.identifier.where( type.coding.exists((system = 'http://fhir.ch/ig/ch-epr-fhir/CodeSystem/PpqmConsentIdentifierType') and (code = 'policySetId')) ).value.lower() = request.url.substring(19).lower())
ch-epr-ppqm-method-equalityerrorBundleHTTP methods of all request shall be the same
: entry.request.method.distinct().count() = 1
ch-epr-ppqm-url-formaterrorBundle.entry.requestURL format shall suit the HTTP method
: ( (method = 'POST') and (url = 'Consent') ) or ( (method != 'POST') and url.startsWith('Consent?identifier=') and url.lower().matches('^consent\\?identifier=urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$') )
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron