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

Resource Profile: BundleTriage

Official URL: https://fhir.cambio.se/StructureDefinition/BundleTriage/v2 Version: 2.0.0
Active as of 2020-10-08 Computable Name: BundleTriage

Introduction

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.

Intended Use

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.

Specific Rules and Limitations

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.

Versions

COS version Profile version Required COSMIC version Date Description
3.5.0 2.0.0 R8.3.05 Nov 2022 Second version

APIs & Supported Operations

HTTP Method Description
PUT Create and update the triage score

Supported Queries

  1. PUT [baseURL]/Bundle/external-ID (create/update)

Error Codes

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:

  • CapabilityStatements using this Profile: Cambio Open Services
  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 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
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entry:ClinicalImpression Σ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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource Σ 1..1 ClinicalImpression A resource in the bundle
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... status ?!Σ 1..1 code in-progress | completed | entered-in-error
Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.
...... subject Σ 1..1 Reference(Patient | Group) Patient or group assessed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.statusrequiredClinicalImpressionStatus
http://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:ClinicalImpressionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:ClinicalImpressionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... meta
.... source S 0..1 uri Identifies where the resource comes from
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for entry 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
.... entry:ClinicalImpression 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ClinicalImpression A resource in the bundle
...... finding
....... itemCodeableConcept
........ coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
... 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 Σ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
.... 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 Σ 0..1 Resource A resource in the bundle
..... 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:ClinicalImpression Σ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
..... 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 Σ 1..1 ClinicalImpression A resource in the bundle
...... id Σ 0..1 string 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.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 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
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier Σ 0..* Identifier Business identifier
...... status ?!Σ 1..1 code in-progress | completed | entered-in-error
Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.
...... statusReason 0..1 CodeableConcept Reason for current status
Binding Description: (example): Codes identifying the reason for the current state of a clinical impression.
...... code Σ 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.
...... description Σ 0..1 string Why/how the assessment was performed
...... subject Σ 1..1 Reference(Patient | Group) Patient or group assessed
...... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
...... effective[x] Σ 0..1 Time of assessment
....... effectiveDateTime dateTime
....... effectivePeriod Period
...... date Σ 0..1 dateTime When the assessment was documented
...... assessor Σ 0..1 Reference(Practitioner | PractitionerRole) The clinician performing the assessment
...... previous 0..1 Reference(ClinicalImpression) Reference to last assessment
...... problem Σ 0..* Reference(Condition | AllergyIntolerance) Relevant impressions of patient state
...... investigation 0..* BackboneElement One or more sets of investigations (signs, symptoms, etc.)
....... 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
....... code 1..1 CodeableConcept A name/code for the set
Binding: InvestigationType (example): A name/code for a set of investigations.
....... item 0..* Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) Record of a specific investigation
...... protocol 0..* uri Clinical Protocol followed
...... summary 0..1 string Summary of the assessment
...... finding 0..* BackboneElement Possible or likely findings and diagnoses
....... 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
....... itemCodeableConcept 0..1 CodeableConcept What was found
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
........ text Σ 0..1 string Plain text representation of the concept
....... itemReference 0..1 Reference(Condition | Observation | Media) What was found
....... basis 0..1 string Which investigations support finding
...... prognosisCodeableConcept 0..* CodeableConcept Estimate of likely outcome
Binding: ClinicalImpressionPrognosis (example): Prognosis or outlook findings.
...... prognosisReference 0..* Reference(RiskAssessment) RiskAssessment expressing likely outcome
...... supportingInfo 0..* Reference(Resource) Information supporting the clinical impression
...... note 0..* Annotation Comments made about the ClinicalImpression
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:ClinicalImpression.resource.statusrequiredClinicalImpressionStatus
http://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.statusReasonexample
Bundle.entry:ClinicalImpression.resource.codeexample
Bundle.entry:ClinicalImpression.resource.investigation.codeexampleInvestigationType
http://hl7.org/fhir/ValueSet/investigation-sets
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.finding.itemCodeableConceptexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.prognosisCodeableConceptexampleClinicalImpressionPrognosis
http://hl7.org/fhir/ValueSet/clinicalimpression-prognosis
From the FHIR Standard
Bundle.entry:ClinicalImpression.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:ClinicalImpressionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:ClinicalImpressionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry
  • The element 1 is sliced based on the value of Bundle.entry.resource.finding.itemCodeableConcept.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 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
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entry:ClinicalImpression Σ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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource Σ 1..1 ClinicalImpression A resource in the bundle
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... status ?!Σ 1..1 code in-progress | completed | entered-in-error
Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.
...... subject Σ 1..1 Reference(Patient | Group) Patient or group assessed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.statusrequiredClinicalImpressionStatus
http://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:ClinicalImpressionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:ClinicalImpressionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... meta
.... source S 0..1 uri Identifies where the resource comes from
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for entry 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
.... entry:ClinicalImpression 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ClinicalImpression A resource in the bundle
...... finding
....... itemCodeableConcept
........ coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
... 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 Σ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
.... 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 Σ 0..1 Resource A resource in the bundle
..... 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:ClinicalImpression Σ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
..... 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 Σ 1..1 ClinicalImpression A resource in the bundle
...... id Σ 0..1 string 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.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 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
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier Σ 0..* Identifier Business identifier
...... status ?!Σ 1..1 code in-progress | completed | entered-in-error
Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression.
...... statusReason 0..1 CodeableConcept Reason for current status
Binding Description: (example): Codes identifying the reason for the current state of a clinical impression.
...... code Σ 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.
...... description Σ 0..1 string Why/how the assessment was performed
...... subject Σ 1..1 Reference(Patient | Group) Patient or group assessed
...... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
...... effective[x] Σ 0..1 Time of assessment
....... effectiveDateTime dateTime
....... effectivePeriod Period
...... date Σ 0..1 dateTime When the assessment was documented
...... assessor Σ 0..1 Reference(Practitioner | PractitionerRole) The clinician performing the assessment
...... previous 0..1 Reference(ClinicalImpression) Reference to last assessment
...... problem Σ 0..* Reference(Condition | AllergyIntolerance) Relevant impressions of patient state
...... investigation 0..* BackboneElement One or more sets of investigations (signs, symptoms, etc.)
....... 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
....... code 1..1 CodeableConcept A name/code for the set
Binding: InvestigationType (example): A name/code for a set of investigations.
....... item 0..* Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) Record of a specific investigation
...... protocol 0..* uri Clinical Protocol followed
...... summary 0..1 string Summary of the assessment
...... finding 0..* BackboneElement Possible or likely findings and diagnoses
....... 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
....... itemCodeableConcept 0..1 CodeableConcept What was found
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
........ text Σ 0..1 string Plain text representation of the concept
....... itemReference 0..1 Reference(Condition | Observation | Media) What was found
....... basis 0..1 string Which investigations support finding
...... prognosisCodeableConcept 0..* CodeableConcept Estimate of likely outcome
Binding: ClinicalImpressionPrognosis (example): Prognosis or outlook findings.
...... prognosisReference 0..* Reference(RiskAssessment) RiskAssessment expressing likely outcome
...... supportingInfo 0..* Reference(Resource) Information supporting the clinical impression
...... note 0..* Annotation Comments made about the ClinicalImpression
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:ClinicalImpression.resource.statusrequiredClinicalImpressionStatus
http://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.statusReasonexample
Bundle.entry:ClinicalImpression.resource.codeexample
Bundle.entry:ClinicalImpression.resource.investigation.codeexampleInvestigationType
http://hl7.org/fhir/ValueSet/investigation-sets
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.finding.itemCodeableConceptexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
Bundle.entry:ClinicalImpression.resource.prognosisCodeableConceptexampleClinicalImpressionPrognosis
http://hl7.org/fhir/ValueSet/clinicalimpression-prognosis
From the FHIR Standard
Bundle.entry:ClinicalImpression.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:ClinicalImpression.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:ClinicalImpressionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:ClinicalImpressionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry
  • The element 1 is sliced based on the value of Bundle.entry.resource.finding.itemCodeableConcept.coding

 

Other representations of profile: CSV, Excel, Schematron