CDC FHIR® Implementation Guide: Anonymized Electronic Initial Case Reporting (eICR)
1.0.0 - ci-build
CDC FHIR® Implementation Guide: Anonymized Electronic Initial Case Reporting (eICR), published by APHL. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/lantanagroup/FHIR-us-eicr-anonymized/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-document-bundle | Version: 1.0.0 | |||
Active as of 2024-11-13 | Computable Name: EICRAnonymizedDocumentBundle |
This Composition profile represents an anonymized eICR Document Bundle.
It is based on the eICR Document Bundle profile with further constraints to require masking the contained eICR Composition.
It also adds invariants (constraints) to check that any required anonymized profiles are present in the Bundle entries.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EICRDocumentBundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | EICRDocumentBundle | US Public Health Document Bundle | |
entry | C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information eicr-anon-text-div: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' eicr-anon-patient: All Patient resources must conform to EICRAnonymizedPatient profile eicr-anon-prct: All Practitioner resources must conform to EICRAnonymizedPractitioner eicr-anon-prct-rol: All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole eicr-anon-enc: All Encounter resources must conform to EICRAnonymizedEncounter eicr-anon-rp: All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson eicr-anon-exposure: US Public Health Exposure Contact Information is not allowed |
resource | C | 0..1 | Resource | A resource in the bundle eicr-anon-display: A reference cannot have a display |
Slices for entry | Content/Rules for all slices | |||
entry:slicePublicHealthComposition | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
resource | 1..1 | EICRAnonymizedComposition | References the Anonymized eICR Composition | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
eicr-anon-display | error | Bundle.entry.resource | A reference cannot have a display : children().where(reference.exists()).display.empty() | |
eicr-anon-enc | error | Bundle.entry | All Encounter resources must conform to EICRAnonymizedEncounter : resource.ofType(Encounter).empty() or resource.ofType(Encounter).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-encounter') | |
eicr-anon-exposure | error | Bundle.entry | US Public Health Exposure Contact Information is not allowed : resource.conformsTo('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-exposure-contact-information').not() | |
eicr-anon-patient | error | Bundle.entry | All Patient resources must conform to EICRAnonymizedPatient profile : resource.ofType(Patient).empty() or resource.ofType(Patient).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient') | |
eicr-anon-prct | error | Bundle.entry | All Practitioner resources must conform to EICRAnonymizedPractitioner : resource.ofType(Practitioner).empty() or resource.ofType(Practitioner).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner') | |
eicr-anon-prct-rol | error | Bundle.entry | All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole : resource.ofType(PractitionerRole).empty() or resource.ofType(PractitionerRole).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole') | |
eicr-anon-rp | error | Bundle.entry | All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson : resource.ofType(RelatedPerson).empty() or resource.ofType(RelatedPerson).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-relatedperson') | |
eicr-anon-text-div | error | Bundle.entry | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : resource.text.exists() implies resource.text.`div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | EICRDocumentBundle | US Public Health Document Bundle 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
identifier | SΣ | 1..1 | Identifier | Document Bundle identifier (equivalent to ClinicalDocument.id in CDA) |
type | SΣ | 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. Fixed Value: document |
Slices for entry | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference eicr-anon-text-div: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' eicr-anon-patient: All Patient resources must conform to EICRAnonymizedPatient profile eicr-anon-prct: All Practitioner resources must conform to EICRAnonymizedPractitioner eicr-anon-prct-rol: All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole eicr-anon-enc: All Encounter resources must conform to EICRAnonymizedEncounter eicr-anon-rp: All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson eicr-anon-exposure: US Public Health Exposure Contact Information is not allowed 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 |
entry:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
resource | ΣC | 0..1 | Resource | A resource in the bundle eicr-anon-display: A reference cannot have a display |
entry:slicePublicHealthComposition | SΣC | 1..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 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 | S | 1..1 | EICRAnonymizedComposition | References the Anonymized eICR Composition |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | 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 | error | 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-5 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | fullUrl cannot be a version specific reference : 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) | |
dom-2 | error | Bundle.entry:slicePublicHealthComposition.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Bundle.entry:slicePublicHealthComposition.resource | A resource should have narrative for robust management : text.`div`.exists() | |
eicr-anon-display | error | Bundle.entry.resource | A reference cannot have a display : children().where(reference.exists()).display.empty() | |
eicr-anon-enc | error | Bundle.entry | All Encounter resources must conform to EICRAnonymizedEncounter : resource.ofType(Encounter).empty() or resource.ofType(Encounter).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-encounter') | |
eicr-anon-exposure | error | Bundle.entry | US Public Health Exposure Contact Information is not allowed : resource.conformsTo('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-exposure-contact-information').not() | |
eicr-anon-patient | error | Bundle.entry | All Patient resources must conform to EICRAnonymizedPatient profile : resource.ofType(Patient).empty() or resource.ofType(Patient).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient') | |
eicr-anon-prct | error | Bundle.entry | All Practitioner resources must conform to EICRAnonymizedPractitioner : resource.ofType(Practitioner).empty() or resource.ofType(Practitioner).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner') | |
eicr-anon-prct-rol | error | Bundle.entry | All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole : resource.ofType(PractitionerRole).empty() or resource.ofType(PractitionerRole).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole') | |
eicr-anon-rp | error | Bundle.entry | All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson : resource.ofType(RelatedPerson).empty() or resource.ofType(RelatedPerson).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-relatedperson') | |
eicr-anon-text-div | error | Bundle.entry | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : resource.text.exists() implies resource.text.`div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | EICRDocumentBundle | US Public Health Document Bundle 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 | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
identifier | SΣ | 1..1 | Identifier | Document Bundle identifier (equivalent to ClinicalDocument.id in CDA) | ||||
type | SΣ | 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. Fixed Value: document | ||||
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 | ||||
Slices for entry | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference eicr-anon-text-div: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' eicr-anon-patient: All Patient resources must conform to EICRAnonymizedPatient profile eicr-anon-prct: All Practitioner resources must conform to EICRAnonymizedPractitioner eicr-anon-prct-rol: All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole eicr-anon-enc: All Encounter resources must conform to EICRAnonymizedEncounter eicr-anon-rp: All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson eicr-anon-exposure: US Public Health Exposure Contact Information is not allowed 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 | ||||
entry:All Slices | Content/Rules for all slices | |||||||
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 | ΣC | 0..1 | Resource | A resource in the bundle eicr-anon-display: A reference cannot have a display | ||||
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) | ||||
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: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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) | ||||
entry:slicePublicHealthComposition | SΣC | 1..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 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 | S | 1..1 | EICRAnonymizedComposition | References the Anonymized eICR Composition | ||||
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) | ||||
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: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard | ||||
Bundle.entry:slicePublicHealthComposition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry:slicePublicHealthComposition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | 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 | error | 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-5 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | fullUrl cannot be a version specific reference : 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) | |
dom-2 | error | Bundle.entry:slicePublicHealthComposition.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Bundle.entry:slicePublicHealthComposition.resource | A resource should have narrative for robust management : text.`div`.exists() | |
eicr-anon-display | error | Bundle.entry.resource | A reference cannot have a display : children().where(reference.exists()).display.empty() | |
eicr-anon-enc | error | Bundle.entry | All Encounter resources must conform to EICRAnonymizedEncounter : resource.ofType(Encounter).empty() or resource.ofType(Encounter).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-encounter') | |
eicr-anon-exposure | error | Bundle.entry | US Public Health Exposure Contact Information is not allowed : resource.conformsTo('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-exposure-contact-information').not() | |
eicr-anon-patient | error | Bundle.entry | All Patient resources must conform to EICRAnonymizedPatient profile : resource.ofType(Patient).empty() or resource.ofType(Patient).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient') | |
eicr-anon-prct | error | Bundle.entry | All Practitioner resources must conform to EICRAnonymizedPractitioner : resource.ofType(Practitioner).empty() or resource.ofType(Practitioner).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner') | |
eicr-anon-prct-rol | error | Bundle.entry | All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole : resource.ofType(PractitionerRole).empty() or resource.ofType(PractitionerRole).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole') | |
eicr-anon-rp | error | Bundle.entry | All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson : resource.ofType(RelatedPerson).empty() or resource.ofType(RelatedPerson).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-relatedperson') | |
eicr-anon-text-div | error | Bundle.entry | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : resource.text.exists() implies resource.text.`div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') | |
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 EICRDocumentBundle
Differential View
This structure is derived from EICRDocumentBundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | EICRDocumentBundle | US Public Health Document Bundle | |
entry | C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information eicr-anon-text-div: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' eicr-anon-patient: All Patient resources must conform to EICRAnonymizedPatient profile eicr-anon-prct: All Practitioner resources must conform to EICRAnonymizedPractitioner eicr-anon-prct-rol: All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole eicr-anon-enc: All Encounter resources must conform to EICRAnonymizedEncounter eicr-anon-rp: All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson eicr-anon-exposure: US Public Health Exposure Contact Information is not allowed |
resource | C | 0..1 | Resource | A resource in the bundle eicr-anon-display: A reference cannot have a display |
Slices for entry | Content/Rules for all slices | |||
entry:slicePublicHealthComposition | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
resource | 1..1 | EICRAnonymizedComposition | References the Anonymized eICR Composition | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
eicr-anon-display | error | Bundle.entry.resource | A reference cannot have a display : children().where(reference.exists()).display.empty() | |
eicr-anon-enc | error | Bundle.entry | All Encounter resources must conform to EICRAnonymizedEncounter : resource.ofType(Encounter).empty() or resource.ofType(Encounter).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-encounter') | |
eicr-anon-exposure | error | Bundle.entry | US Public Health Exposure Contact Information is not allowed : resource.conformsTo('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-exposure-contact-information').not() | |
eicr-anon-patient | error | Bundle.entry | All Patient resources must conform to EICRAnonymizedPatient profile : resource.ofType(Patient).empty() or resource.ofType(Patient).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient') | |
eicr-anon-prct | error | Bundle.entry | All Practitioner resources must conform to EICRAnonymizedPractitioner : resource.ofType(Practitioner).empty() or resource.ofType(Practitioner).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner') | |
eicr-anon-prct-rol | error | Bundle.entry | All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole : resource.ofType(PractitionerRole).empty() or resource.ofType(PractitionerRole).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole') | |
eicr-anon-rp | error | Bundle.entry | All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson : resource.ofType(RelatedPerson).empty() or resource.ofType(RelatedPerson).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-relatedperson') | |
eicr-anon-text-div | error | Bundle.entry | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : resource.text.exists() implies resource.text.`div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | EICRDocumentBundle | US Public Health Document Bundle 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
identifier | SΣ | 1..1 | Identifier | Document Bundle identifier (equivalent to ClinicalDocument.id in CDA) |
type | SΣ | 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. Fixed Value: document |
Slices for entry | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference eicr-anon-text-div: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' eicr-anon-patient: All Patient resources must conform to EICRAnonymizedPatient profile eicr-anon-prct: All Practitioner resources must conform to EICRAnonymizedPractitioner eicr-anon-prct-rol: All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole eicr-anon-enc: All Encounter resources must conform to EICRAnonymizedEncounter eicr-anon-rp: All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson eicr-anon-exposure: US Public Health Exposure Contact Information is not allowed 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 |
entry:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
resource | ΣC | 0..1 | Resource | A resource in the bundle eicr-anon-display: A reference cannot have a display |
entry:slicePublicHealthComposition | SΣC | 1..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 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 | S | 1..1 | EICRAnonymizedComposition | References the Anonymized eICR Composition |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | 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 | error | 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-5 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | fullUrl cannot be a version specific reference : 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) | |
dom-2 | error | Bundle.entry:slicePublicHealthComposition.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Bundle.entry:slicePublicHealthComposition.resource | A resource should have narrative for robust management : text.`div`.exists() | |
eicr-anon-display | error | Bundle.entry.resource | A reference cannot have a display : children().where(reference.exists()).display.empty() | |
eicr-anon-enc | error | Bundle.entry | All Encounter resources must conform to EICRAnonymizedEncounter : resource.ofType(Encounter).empty() or resource.ofType(Encounter).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-encounter') | |
eicr-anon-exposure | error | Bundle.entry | US Public Health Exposure Contact Information is not allowed : resource.conformsTo('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-exposure-contact-information').not() | |
eicr-anon-patient | error | Bundle.entry | All Patient resources must conform to EICRAnonymizedPatient profile : resource.ofType(Patient).empty() or resource.ofType(Patient).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient') | |
eicr-anon-prct | error | Bundle.entry | All Practitioner resources must conform to EICRAnonymizedPractitioner : resource.ofType(Practitioner).empty() or resource.ofType(Practitioner).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner') | |
eicr-anon-prct-rol | error | Bundle.entry | All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole : resource.ofType(PractitionerRole).empty() or resource.ofType(PractitionerRole).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole') | |
eicr-anon-rp | error | Bundle.entry | All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson : resource.ofType(RelatedPerson).empty() or resource.ofType(RelatedPerson).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-relatedperson') | |
eicr-anon-text-div | error | Bundle.entry | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : resource.text.exists() implies resource.text.`div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | EICRDocumentBundle | US Public Health Document Bundle 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 | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
identifier | SΣ | 1..1 | Identifier | Document Bundle identifier (equivalent to ClinicalDocument.id in CDA) | ||||
type | SΣ | 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. Fixed Value: document | ||||
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 | ||||
Slices for entry | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference eicr-anon-text-div: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' eicr-anon-patient: All Patient resources must conform to EICRAnonymizedPatient profile eicr-anon-prct: All Practitioner resources must conform to EICRAnonymizedPractitioner eicr-anon-prct-rol: All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole eicr-anon-enc: All Encounter resources must conform to EICRAnonymizedEncounter eicr-anon-rp: All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson eicr-anon-exposure: US Public Health Exposure Contact Information is not allowed 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 | ||||
entry:All Slices | Content/Rules for all slices | |||||||
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 | ΣC | 0..1 | Resource | A resource in the bundle eicr-anon-display: A reference cannot have a display | ||||
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) | ||||
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: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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) | ||||
entry:slicePublicHealthComposition | SΣC | 1..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 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 | S | 1..1 | EICRAnonymizedComposition | References the Anonymized eICR Composition | ||||
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) | ||||
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: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
ifMatch | Σ | 0..1 | string | For managing update contention | ||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard | ||||
Bundle.entry:slicePublicHealthComposition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry:slicePublicHealthComposition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | 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 | error | 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-5 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:slicePublicHealthComposition | fullUrl cannot be a version specific reference : 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) | |
dom-2 | error | Bundle.entry:slicePublicHealthComposition.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.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 | error | Bundle.entry:slicePublicHealthComposition.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Bundle.entry:slicePublicHealthComposition.resource | A resource should have narrative for robust management : text.`div`.exists() | |
eicr-anon-display | error | Bundle.entry.resource | A reference cannot have a display : children().where(reference.exists()).display.empty() | |
eicr-anon-enc | error | Bundle.entry | All Encounter resources must conform to EICRAnonymizedEncounter : resource.ofType(Encounter).empty() or resource.ofType(Encounter).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-encounter') | |
eicr-anon-exposure | error | Bundle.entry | US Public Health Exposure Contact Information is not allowed : resource.conformsTo('http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-exposure-contact-information').not() | |
eicr-anon-patient | error | Bundle.entry | All Patient resources must conform to EICRAnonymizedPatient profile : resource.ofType(Patient).empty() or resource.ofType(Patient).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient') | |
eicr-anon-prct | error | Bundle.entry | All Practitioner resources must conform to EICRAnonymizedPractitioner : resource.ofType(Practitioner).empty() or resource.ofType(Practitioner).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner') | |
eicr-anon-prct-rol | error | Bundle.entry | All PractitionerRole resources must conform to EICRAnonymizedPractitionerRole : resource.ofType(PractitionerRole).empty() or resource.ofType(PractitionerRole).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole') | |
eicr-anon-rp | error | Bundle.entry | All RelatedPerson resources must conform to EICRAnonymizedRelatedPerson : resource.ofType(RelatedPerson).empty() or resource.ofType(RelatedPerson).conformsTo('http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-relatedperson') | |
eicr-anon-text-div | error | Bundle.entry | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : resource.text.exists() implies resource.text.`div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') | |
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 EICRDocumentBundle
Other representations of profile: CSV, Excel, Schematron