1.0.0 - release
            
          
CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.cambio.se/StructureDefinition/BundleTriage/v2 | Version: 2.0.0 | |||
| Active as of 2020-10-08 | Computable Name: BundleTriage | |||
The BundleTriage profile may be used as a container for sending the ClinicalImpressionRetts and the included vital signs in one data transfer. BundleTriage is created from the Bundle resource in FHIR R4 edition.
If the ClinicalImpression is sent in a Bundle where all resources related to the ClinicalImpression are included, the COSMIC Mediator construct a ClinicalImpression with resources from the bundle as contained resources. When the ClinicalImpression has been resolved, the Mediator calls the COSMIC Triage module to create the triage.
When a RETTS Triage is created, the internal id of this triage (COSMIC care entry) is included in the content-location header in the response from Mediator. This id can then be used for updating an existing RETTS triages. By including the id as an identifier in the request, the old triage with that id will be invalidated and a new one created.
| Type | Description | 
|---|---|
| Rule | For creating triage data the external user must not be the patient. E.g. A healthcare professional is the intended user to create triage data with this API. | 
| COS version | Profile version | Required COSMIC version | Date | Description | 
|---|---|---|---|---|
| 3.5.0 | 2.0.0 | R8.3.05 | Nov 2022 | Second version | 
| HTTP Method | Description | 
|---|---|
| PUT | Create and update the triage score | 
PUT [baseURL]/Bundle/external-ID (create/update)Specific error messages for Bundle are listed below.
| Code | Description | Comment | 
|---|---|---|
| 422 | A ClinicalImpression must be presented | In the TriageBundle there should be a One ClinicalImpression resource as an entry | 
| 422 | Supports only for single clinicalImpression | In the TriageBundle there should not be more than one ClinicalImpression resources as entries | 
| 400 | TriageDateTime=YYYY-MM-DDTHH:MM:SS.SSS >= YYYY-MM-DDTHH:MM:SS.SSS | The entered TriageDateTime cannot be in the future. It has to be the current time or in the past. | 
| 400 | The Snomed Code for […] could not be translated | There is no mapping between the entered SNOMED code and the corresponding OpenEHR code on the FHIR server | 
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | 
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | 
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
Σ | 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.  | 
![]() ![]()  | 
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | 
![]() ![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]()  | 
ΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | ClinicalImpression | A resource in the bundle | 
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]() ![]() ![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.  | 
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | Patient or group assessed | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | |
| Bundle.entry:ClinicalImpression.resource.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1From 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:ClinicalImpression | 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:ClinicalImpression | 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)  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Bundle | Contains a collection of resources | |
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
S | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]()  | 
1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource  | |
![]() ![]() ![]()  | 
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]()  | 
1..1 | ClinicalImpression | A resource in the bundle | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system  | |
  Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.  | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".  | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]()  | 
Σ | 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.  | ||||
![]() ![]()  | 
Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]()  | 
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]()  | 
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | ||||
![]() ![]() ![]()  | 
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | match | include | 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.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]()  | 
ΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | ClinicalImpression | A resource in the bundle | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a clinical impression.  | |||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | CodeableConcept | Kind of assessment performed Binding Description: (example): Identifies categories of clinical impressions. This is a place-holder only. It may be removed.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Why/how the assessment was performed | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | Patient or group assessed | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Time of assessment | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Period | |||||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | dateTime | When the assessment was documented | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The clinician performing the assessment | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Reference(ClinicalImpression) | Reference to last assessment | |||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Reference(Condition | AllergyIntolerance) | Relevant impressions of patient state | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | One or more sets of investigations (signs, symptoms, etc.) | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | A name/code for the set Binding: InvestigationType (example): A name/code for a set of investigations.  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) | Record of a specific investigation | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | uri | Clinical Protocol followed | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Summary of the assessment | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Possible or likely findings and diagnoses | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | What was found Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | Reference(Condition | Observation | Media) | What was found | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Which investigations support finding | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | CodeableConcept | Estimate of likely outcome Binding: ClinicalImpressionPrognosis (example): Prognosis or outlook findings.  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Reference(RiskAssessment) | RiskAssessment expressing likely outcome | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Reference(Resource) | Information supporting the clinical impression | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Annotation | Comments made about the ClinicalImpression | |||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | match | include | 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.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]()  | 
Σ | 0..1 | Signature | Digital Signature | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Bundle.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard  | ||||
| Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard  | ||||
| Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1From the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Bundle.entry:ClinicalImpression.resource.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1From the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.statusReason | example | |||||
| Bundle.entry:ClinicalImpression.resource.code | example | |||||
| Bundle.entry:ClinicalImpression.resource.investigation.code | example | InvestigationTypehttp://hl7.org/fhir/ValueSet/investigation-setsFrom the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.finding.itemCodeableConcept | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codeFrom the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.prognosisCodeableConcept | example | ClinicalImpressionPrognosishttp://hl7.org/fhir/ValueSet/clinicalimpression-prognosisFrom the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1From the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1From 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:ClinicalImpression | 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:ClinicalImpression | 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)  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
This structure is derived from Bundle
Summary
Mandatory: 3 elements(2 nested mandatory elements)
 Must-Support: 1 element
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | 
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | 
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
Σ | 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.  | 
![]() ![]()  | 
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | 
![]() ![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]()  | 
ΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | ClinicalImpression | A resource in the bundle | 
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]() ![]() ![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.  | 
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | Patient or group assessed | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | |
| Bundle.entry:ClinicalImpression.resource.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1From 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:ClinicalImpression | 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:ClinicalImpression | 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)  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Bundle | Contains a collection of resources | |
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
S | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]()  | 
1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource  | |
![]() ![]() ![]()  | 
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() ![]() ![]()  | 
1..1 | ClinicalImpression | A resource in the bundle | |
![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system  | |
  Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.  | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".  | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]()  | 
Σ | 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.  | ||||
![]() ![]()  | 
Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]()  | 
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]()  | 
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | ||||
![]() ![]() ![]()  | 
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | match | include | 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.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]()  | 
ΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | ClinicalImpression | A resource in the bundle | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a clinical impression.  | |||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | CodeableConcept | Kind of assessment performed Binding Description: (example): Identifies categories of clinical impressions. This is a place-holder only. It may be removed.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Why/how the assessment was performed | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | Patient or group assessed | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Time of assessment | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
Period | |||||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | dateTime | When the assessment was documented | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The clinician performing the assessment | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | Reference(ClinicalImpression) | Reference to last assessment | |||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..* | Reference(Condition | AllergyIntolerance) | Relevant impressions of patient state | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | One or more sets of investigations (signs, symptoms, etc.) | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | A name/code for the set Binding: InvestigationType (example): A name/code for a set of investigations.  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) | Record of a specific investigation | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | uri | Clinical Protocol followed | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Summary of the assessment | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | BackboneElement | Possible or likely findings and diagnoses | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | CodeableConcept | What was found Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system  | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | Reference(Condition | Observation | Media) | What was found | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Which investigations support finding | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | CodeableConcept | Estimate of likely outcome Binding: ClinicalImpressionPrognosis (example): Prognosis or outlook findings.  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Reference(RiskAssessment) | RiskAssessment expressing likely outcome | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Reference(Resource) | Information supporting the clinical impression | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Annotation | Comments made about the ClinicalImpression | |||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | match | include | 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.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.  | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]()  | 
Σ | 0..1 | Signature | Digital Signature | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Bundle.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard  | ||||
| Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard  | ||||
| Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1From the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Bundle.entry:ClinicalImpression.resource.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1From the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.statusReason | example | |||||
| Bundle.entry:ClinicalImpression.resource.code | example | |||||
| Bundle.entry:ClinicalImpression.resource.investigation.code | example | InvestigationTypehttp://hl7.org/fhir/ValueSet/investigation-setsFrom the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.finding.itemCodeableConcept | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codeFrom the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.resource.prognosisCodeableConcept | example | ClinicalImpressionPrognosishttp://hl7.org/fhir/ValueSet/clinicalimpression-prognosisFrom the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1From the FHIR Standard  | ||||
| Bundle.entry:ClinicalImpression.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1From 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:ClinicalImpression | 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:ClinicalImpression | 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)  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
This structure is derived from Bundle
Summary
Mandatory: 3 elements(2 nested mandatory elements)
 Must-Support: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron