HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Content Bundle

Defining URL:http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-content-bundle
Version:2.0.0
Name:USPublicHealthContentBundle
Title:US Public Health Content Bundle
Status:Draft as of 9/1/19
Definition:

Bundle Resource profile for exchanging public health messages, knowledge artifacts or content.

Publisher:HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-content-bundle

Formal Views of Profile Content

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

This structure is derived from Bundle

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Fixed Value: 1 element

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleUS Public Health Content Bundle
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: collection
... timestamp S0..1instantWhen the bundle was assembled
... entry S1..*BackboneElementEntry in the bundle - will have a resource or information

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleUS Public Health Content Bundle
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codedocument | 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.


Fixed Value: collection
... timestamp SΣ0..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource Σ0..1ResourceA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing cache currency
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleUS Public Health Content Bundle
... type Σ1..1codedocument | 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.


Fixed Value: collection
... timestamp Σ0..1instantWhen the bundle was assembled
... entry ΣI1..*BackboneElementEntry in the bundle - will have a resource or information
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

doco Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Fixed Value: 1 element

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleUS Public Health Content Bundle
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: collection
... timestamp S0..1instantWhen the bundle was assembled
... entry S1..*BackboneElementEntry in the bundle - will have a resource or information

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleUS Public Health Content Bundle
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codedocument | 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.


Fixed Value: collection
... timestamp SΣ0..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource Σ0..1ResourceA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing cache currency
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Max Binding: AllLanguages
Bundle.typerequiredFixed Value: collection
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb

Constraints

IdGradePathDetailsRequirements
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-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-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)
ele-1errorBundle.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.timestampAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.totalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.link.relationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.link.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
bdl-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ele-1errorBundle.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.fullUrlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.searchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.search.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.search.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.search.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.search.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.search.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.search.scoreAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.request.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.request.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.request.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.request.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifNoneMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifModifiedSinceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifNoneExistAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.response.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.etagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.lastModifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.signatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())