The FHIR profiles used for the Vaccinations List
Heading Description
The details of a women’s vaccinations.
Vaccinations Details Structure
Maternity Data Standards Mapping to FHIR profiles
Mapping Overview
| Data Standard Element | FHIR Profile | FHIR target |
| Date and Time of vaccinations | Encounter | period.start |
| ODS/ORD Site Code | Location | identifier |
| Performing Professional | Practitioner | identifier and name |
| SDS Job Role Name | PractitionerRole | code |
| Reported Date | Immunization | date |
| Primary Source | Immunization | primarySource |
| Report Origin | Immunization | reportOrigin |
| Vaccination Procedure | Immunization | extension.vaccinationProcedure |
| Vaccination Situation (Not Given Outcome) | Immunization | explanation.reasonNotGiven |
| Not Given flag | Immunization | notGiven |
| Dose sequence | Immunization | vaccinationProtocol.doseSequence |
| Vaccine Product | Immunization | vaccineCode.coding.code |
| Vaccine Manufacturer | Immunization | manufacturer |
| Batch Number | Immunization | lotNumber |
| Site of Vaccination | Immunization | site |
| Route of Vaccination | Immunization | route |
| Dose Amount | Immunization | doseQuantity |
| Indication | Immunization | reason |
Mapping for Vaccination Details List
| > | Level 1 | List Resource | > | Level 2 | CareConnect-List-1 Profile | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| List | | Information summarized from a list of other resources Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource Constraint (lst-2): The deleted flag can only be used if the mode of the list is “changes” Constraint (lst-1): A list can only have an emptyReason if it is empty |
||
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-List-1' |
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
| - language | 0..1 | Not Used | Code | Language of the resource content Binding (extensible): A human language. Common Languages |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - extension (clinicalSetting) | 0..1 | Not Used | Extension-CareConnect-ClinicalSetting-1 | To record the clinical setting of a problem list Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (warningCode) | 0..1 | Not Used | Extension-CareConnect-ListWarningCode-1 | To capture warnings that the list may be incomplete Constraint (ext-1): Must have either extensions or value[x], not both |
| - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
| - identifier | 0..* | Required | Identifier | Business identifier An identifier for this vaccination details list |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
| - - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came from |
| - - value | 1..1 | Mandatory | String | The value that is unique Business identifier An identifier for this vaccination details list |
| - - period | 0..1 | Not Used | Period | A identifier' |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Required | String | Text alternative for the resource The organization that allocated the identifier |
| - status | 1..1 | Mandatory | Code | current : retired : entered-in-error Binding (required): The current state of the list ListStatus The status of the list MUST contain the value 'current' |
| - mode | 1..1 | Mandatory | Code | working : snapshot : changes Binding (required): The processing mode that applies to this list ListMode The mode of the list MUST contain the value 'snapshot' |
| - title | 0..1 | Mandatory | String | Descriptive name for the list This MUST contain the value 'Admission details' Mapping to Maternity data item = 'PSRB Heading Immunisation details' |
| - code | 0..1 | Mandatory | CodeableConcept | What the purpose of this list is Binding (preferred): What the purpose of a list is CareConnect-ListCode-1 The PRSB heading for this list. Note: for Maternity the value stated below is used which is not from the preferred value set |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system The SNOMED CT concept for the PRSB heading type |
| - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system This MUST contain the value 'http://snomed.info/sct' |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant Mapping to Maternity Data item Not applicable |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system This MUST contain the value '1102181000000102' |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Immunisations' Mapping to Maternity data item = 'PSRB Heading Immunisation details' |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - subject | 0..1 | Mandatory | Reference | If all resources have the same subject Constraint (ref-1): SHALL have a contained resource if a local reference is provided This is a reference to the Patient who is the subject of the list. |
| Not Used | Group | |||
| Not Used | Device | |||
| Mandatory | CareConnect-Patient-1 | This is the subject of the vaccination details List. This MUST use the CareConnect patient profile. Seepatient resource reference for information on how to populate the resource. |
||
| Not Used | CareConnect-Location-1 | |||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - encounter | 0..1 | Not Used | Reference | Context in which list created Constraint (ref-1): SHALL have a contained resource if a local reference is provided A reference to the encounter resource within the Admission details list. </font/> |
| Not Used | CareConnect-Encounter-1 | This is the context of the Admission details List. This MUST use the CareConnect encounter profile. See encounter resource for information on how to populate the resource. |
||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - date | 0..1 | Mandatory | dateTime | When the list was prepared This MUST contain a system date to indicate when the list was created or updated |
| - source | 0..1 | Not Used | Reference | Who and/or what defined the list contents (aka Author) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Device | |||
| Not Used | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Practitioner-1 | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - orderedBy | 0..1 | Not Used | CodeableConcept | What order the list has Binding (preferred): What order applies to the items in a list List Order Codes |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - note | 0..* | Optional | Annotation | Comments about the list |
| - - author[x] | 0..1 | Not Used | Reference | Individual responsible for the annotation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | RelatedPerson | |||
| Not Used | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Practitioner-1 | |||
| Required | String | Who authored the comment on the list. | ||
| - - time | 0..1 | Required | dateTime | When the annotation was made |
| - - text | 1..1 | Required | String | The annotation - text content |
| - entry | 0..* | Mandatory | BackboneElement | Entries in the list The entries MUST be as per the diagram for this PRSB headings list with the encounter resource being the focal resource. Multiple Encounters with associated resources MAY be present |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - flag | 0..1 | Not Used | CodeableConcept | Status/Workflow information about this item Binding (example): Codes that provide further information about the reason and meaning of the item in the list Patient Medicine Change Types |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - deleted | 0..1 | Not Used | Boolean | If this item is actually marked as deleted Default Value: false |
| - - date | 0..1 | Required | dateTime | When item added to list The SHOULD contain a system time of when the item was added to the list. |
| - - item | 1..1 | Required | Reference | Actual entry Constraint (ref-1): SHALL have a contained resource if a local reference is provided A reference to an Encounter resource included in the list This MUST use the CareConnect Encounter profile. See Encounter resource for information on how to populate the resource. |
| Not Used | Resource | |||
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL The reference to the included Encounter resource. |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - emptyReason | 0..1 | Not Used | CodeableConcept | Why list is empty Binding (preferred): If a list is empty, why it is empty CareConnect-ListEmptyReasonCode-1 |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
Patient Reference
The vaccination details list has a mandated subject reference to the Patient resource. This means that any exchange of the vaccination details heading data must also include the Patient demographics List.
Mapping for Vaccinations
| > | Level 1 | Immunization Resource | > | Level 2 | CareConnect-Immunization-1 Profile | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Digital Maternity Implementation | |
|---|---|---|---|---|---|
| Immunization | | Immunization event information Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource Constraint (imm-2): If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. Constraint (imm-1): If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present |
|||
| - id | 0..1 | Optional | Id | Logical id of this artifact | |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource | |
| - - profile | 1..1 | Mandatory | Uri | Profiles this resource claims to conform to The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-AllergyIntolerance-1' |
|
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created | |
| - language | 0..1 | Not Used | Code | Language of the resource content Binding (extensible): A human language. Common Languages |
|
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation | |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources | |
| - extension (parentPresent) | 0..1 | Not Used | Extension-CareConnect-ParentPresent-1 | Was a parent present at the Immunization Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - extension (recordedDate) | 0..1 | Not Used | Extension-CareConnect-DateRecorded-1 | The date that the Vaccination was recorded Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - extension (vaccinationProcedure) | 0..1 | Required | Extension-CareConnect-VaccinationProcedure-1 | An extension to hold an immunization procedure code Constraint (ext-1): Must have either extensions or value[x], not both Only use SNOMED CT coding or free text where no SNOMED CT code is available. |
|
| - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
|
| - identifier | 0..* | Required | Identifier | Business identifier | |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
|
| - - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes |
|
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system | |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system | |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system | |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system | |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept | |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value | |
| - - value | 1..1 | Mandatory | String | The value that is unique | |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
|
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary | |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing | |
| - - assigner | 0..1 | Required | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
|
| CareConnect-Organization-1 | |||||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL | |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - - display | 0..1 | Required | String | Text alternative for the resource | |
| - status | 1..1 | Mandatory | Code | Completed Binding (required): A set of codes indicating the current status of an Immunization Immunization Status Codes The status of the list MUST contain the value 'Completed' |
|
| - notGiven | 1..1 | Mandatory | Boolean | Flag for whether immunization was given true = not given false = given |
|
| - vaccineCode | 1..1 | Optional | CodeableConcept | Vaccine product administered Binding (extensible): The code for vaccine product administered CareConnect-VaccineCode-1 |
|
| - - coding | 0..* | Optional | Coding | Code defined by a terminology system | |
| - - - system | 0..1 | Optional | Uri | Identity of the terminology system | |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - code | 0..1 | Optional | Code | Symbol in syntax defined by the system | |
| - - - display | 0..1 | Optional | String | Representation defined by the system | |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - text | 0..1 | Optional | String | Plain text representation of the concept | |
| - patient | 1..1 | Mandatory | Reference | Who was immunized Constraint (ref-1): SHALL have a contained resource if a local reference is provided This is a reference to the Patient who is the subject of the list. |
|
| CareConnect-Patient-1 | This is the subject of the Immunisation details List. This MUST use the CareConnect patient profile. Seepatient resource reference for information on how to populate the resource. |
||||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL This must use the CareConnect Patient profile.See patient resource reference for information on how to populate the resource |
|
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - display | 0..1 | Not Used | String | Text alternative for the resource | |
| - encounter | 0..1 | Mandatory | Reference | Encounter administered as part of Constraint (ref-1): SHALL have a contained resource if a local reference is provided This is a reference to the vaccination encounter. |
|
| CareConnect-Encounter-1 | This is the context of the vaccination details List. This MUST use the CareConnect encounter profile. See encounter resource for information on how to populate the resource. |
||||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the encounter resource included in the vaccination list within the FHIR Bundle. |
|
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - display | 0..1 | Not Used | String | Text alternative for the resource | |
| - date | 0..1 | Mandatory | dateTime | Vaccination administration date The date/time on which the immunisation intervention was carried out or was meant to be administered |
|
| - primarySource | 1..1 | Mandatory | Boolean | Indicates context the data was recorded in Default Value: true false if reported |
|
| - reportOrigin | 0..1 | Required | CodeableConcept | Indicates the source of a secondarily reported record Binding (example): The source of the data for a record which is not from a primary source. Immunization Origin Codes |
|
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system | |
| - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system | |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system | |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system | |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept | |
| - location | 0..1 | Mandatory | Reference | Where vaccination occurred Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
|
| CareConnect-Location-1 | This is the location where the vaccination took place. This MUST use the CareConnect location profile. | ||||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL | |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - display | 0..1 | Not Used | String | Text alternative for the resource | |
| - manufacturer | 0..1 | Optional | Reference | Vaccine manufacturer Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
|
| CareConnect-Organization-1 | |||||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL | |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - display | 0..1 | Not Used | String | Text alternative for the resource | |
| - lotNumber | 0..1 | Optional | String | Vaccine lot number The batch number of the vaccine product |
|
| - expirationDate | 0..1 | Not Used | Date | Vaccine expiration date | |
| - site | 0..1 | Optional | CodeableConcept | Body site vaccine was administered Binding (examle): The site at which the vaccine was administered Codes for Immunization Site of Administration The immunization site does not use the preferred value set but uses SNOMED CT concepts instead Mapping to Maternity data item = 'site'. |
|
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
|
| - - coding (snomedCT) | 0..1 | Optional | Coding | Code defined by a terminology system The immunization site does not use the preferred value set but uses SNOMED CT concepts instead Mapping to Maternity data item = 'site'. |
|
| - - - extension (snomedCTDescriptionID) | 0..1 | Optional | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
|
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system A SNOMED CT code |
|
| - - - display | 1..1 | Mandatory | String | Representation defined by the system The display associated with the SNOMED CT concept. This SHOULD be the preferred term |
|
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - text | 0..1 | Optional | String | Plain text representation of the concept This element SHOULD only be populated when the Immunisation cannot be coded or when stating one of the following statements: ‘No known site’ Or ‘Information not available’. |
|
| - route | 0..1 | Optional | CodeableConcept | How vaccine entered body Binding (example): The route by which the vaccine was administered Immunization Route Codes Note the example valueSet is not used for Maternity and the following should be used instead Coded text - SNOMED CT (<284009009 |
Route of administration value (qualifier value))</font> |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
|
| - - coding (snomedCT) | 0..1 | Optional | Coding | Code defined by a terminology system Binding (example): A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. CareConnect-MedicationDosageRoute-1 Note the example valueSet is not used for Maternity and the following should be used instead Coded text - SNOMED CT (<284009009 |
Route of administration value (qualifier value))</font> |
| - - - extension (snomedCTDescriptionID) | 0..1 | Optional | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
|
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system Coded text - SNOMED CT (<284009009 |
Route of administration value (qualifier value))</font> |
| - - - display | 1..1 | Mandatory | String | Representation defined by the system This SHOULD be the preferred term for the SNOMED concept |
|
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - text | 0..1 | Optional | String | Plain text representation of the concept This element SHOULD only be populated when the Immunisation cannot be coded or when stating one of the following statements: 'No known route' Or 'Information not available'. |
|
| - doseQuantity | 0..1 | Optional | Quantity (SimpleQuantity ) | Amount of vaccine administered Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (sqty-1): The comparator is not used on a SimpleQuantity Amount of vaccine administered |
|
| - - value | 0..1 | Required | Decimal | Numerical value (with implicit precision) | |
| - - unit | 0..1 | Required | String | Unit representation | |
| - - system | 0..1 | Required | Uri | System that defines coded unit form | |
| - - code | 0..1 | Required | Code | Coded form of the unit | |
| - practitioner | 0..* | Mandatory | BackboneElement | Who performed event | |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - - role | 0..1 | Mandatory | CodeableConcept | What type of performance was done Binding (extensible): The role a practitioner plays in the immunization event Immunization Role Codes |
|
| - - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system | |
| - - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system | |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system | |
| - - - - display | 0..1 | Mandatory | String | Representation defined by the system | |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - - text | 0..1 | Optional | String | Plain text representation of the concept | |
| - - actor | 1..1 | Mandatory | Reference | Individual who was performing Constraint (ref-1): SHALL have a contained resource if a local reference is provided This MUST be a reference to the Practitioner resource |
|
| Required | CareConnect-Practitioner-1 | The responsible clinician for the encounter. This MUST use the CareConnect Practitioner profile. See Practitioner resource for information on how to populate the resource. |
|||
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the Practitioner resource included in the Immunisation details list |
|
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource | |
| - note | 0..* | Optional | Annotation | Vaccination notes | |
| - - author[x] | 0..1 | Not Used | Reference | Individual responsible for the annotation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
|
| RelatedPerson | |||||
| CareConnect-Practitioner-1 | |||||
| CareConnect-Patient-1 | |||||
| String | |||||
| - - time | 0..1 | Not Used | dateTime | When the annotation was made | |
| - - text | 1..1 | Not Used | String | The annotation - text content | |
| - explanation | 0..1 | Optional | BackboneElement | Administration/non-administration reasons The clinical indication or reason for administering or recording an historical vaccination. |
|
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - - reason | 0..* | Optional | CodeableConcept | Why immunization occurred Binding (example): The reason why a vaccine was administered CareConnect-ImmunizationExplanationReason-2 |
|
| - - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system | |
| - - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system This MUST contain the value 'http://snomed.info/sct' |
|
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system | |
| - - - - display | 0..1 | Mandatory | String | Representation defined by the system | |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept | |
| - - reasonNotGiven | 0..1 | Required | CodeableConcept | Why immunization did not occur Binding (example): The reason why a vaccine was not administered Immunization Reasons for Not Immunizing Codes Where a vaccine is not administered a PROCEDURE WITH EXPLICIT CONTEXT (SNOMED CT). Codes TBA |
|
| - - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system | |
| - - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system | |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system | |
| - - - - display | 0..1 | Mandatory | String | Representation defined by the system | |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - - text | 0..1 | Optional | String | Plain text representation of the concept | |
| - reaction | 0..* | Not Used | BackboneElement | Details of a reaction that follows immunization | |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - - date | 0..1 | Not Used | dateTime | When reaction started | |
| - - detail | 0..1 | Not Used | Reference | Additional information on reaction Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
|
| CareConnect-Observation-1 | |||||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL | |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource | |
| - - reported | 0..1 | Not Used | Boolean | Indicates self-reported reaction | |
| - vaccinationProtocol | 0..* | Mandatory | BackboneElement | What protocol was followed | |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - - doseSequence | 1..1 | Required | positiveInt | Dose number within series Nominal position in a series of vaccines |
|
| - - description | 0..1 | Not Used | String | Details of vaccine protocol | |
| - - authority | 0..1 | Not Used | Reference | Who is responsible for protocol Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
|
| CareConnect-Organization-1 | |||||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL | |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known | |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource | |
| - - series | 0..1 | Not Used | String | Name of vaccine series | |
| - - seriesDoses | 0..1 | Not Used | positiveInt | Recommended number of doses for immunity | |
| - - targetDisease | 1..* | Not Used | CodeableConcept | Disease immunized against Binding (example): The disease target of the vaccination protocol Vaccination Protocol Dose Target Codes |
|
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
|
| - - - coding (snomedCT) | 0..1 | Not Used | Coding | Code defined by a terminology system | |
| - - - - extension (snomedCTDescriptionID) | 0..1 | Not Used | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
|
| - - - - system | 1..1 | Not Used | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
|
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system | |
| - - - - display | 1..1 | Not Used | String | Representation defined by the system | |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept | |
| - - doseStatus | 1..1 | Not Used | CodeableConcept | Indicates if dose counts towards immunity Binding (example): The status of the vaccination protocol (i.e. should this count) Vaccination Protocol Dose Status codes |
|
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system | |
| - - - - system | 1..1 | Not Used | Uri | Identity of the terminology system | |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system | |
| - - - - display | 1..1 | Not Used | String | Representation defined by the system | |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept | |
| - - doseStatusReason | 0..1 | Not Used | CodeableConcept | Why dose does (not) count Binding (example): The reason for the determining if a vaccination should count or why vaccination should not count. Vaccination Protocol Dose Status Reason codes |
|
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system | |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system | |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant | |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system | |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system | |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user | |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
Mapping for Vaccination Encounter
| > | Level 1 | Encounter Resource | > | Level 2 | CareConnect-Encounter-1 | > | Level 3 | None |
| View Used FHIR Elements* | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Encounter | | An interaction during which services are provided to the patient Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
||
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1' |
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
| - language | 0..1 | Not Used | Code | Language of the resource content Binding (extensible): A human language. Common Languages |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - extension (encounterTransport) | 0..1 | Not Used | Extension-CareConnect-EncounterTransport-1 | Encounter transport Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (outcomeOfAttendance) | 0..1 | Not Used | Extension-CareConnect-OutcomeOfAttendance-1 | An extension to the Encounter resource to record the outcome of an Out-Patient attendance. Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (emergencyCareDischargeStatus) | 0..1 | Not Used | Extension-CareConnect-EmergencyCareDischargeStatus-1 | An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. Constraint (ext-1): Must have either extensions or value[x], not both |
| - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
| - identifier | 0..* | Required | Identifier | Identifier(s) by which this encounter is known An identifier for this Encounter |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
| - - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came from |
| - - value | 1..1 | Required | String | The value that is unique An identifier for this Vaccination encounter |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-1 | |||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - status | 1..1 | Mandatory | Code | planned : arrived : triaged : in-progress : onleave : finished : cancelled + Binding (required): Current state of the encounter EncounterStatus The status of the Encounter MUST contain the value 'finished' |
| - statusHistory | 0..* | Not Used | BackboneElement | List of past encounter statuses |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - status | 1..1 | Not Used | Code | planned : arrived : triaged : in-progress : onleave : finished : cancelled + Binding (required): Current state of the encounter EncounterStatus |
| - - period | 1..1 | Not Used | Period | The time that the episode was in the specified status Constraint (per-1): If present, start SHALL have a lower value than end Mapping to Maternity data item ='Date/Time' |
| - - - start | 0..1 | Required | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Required | dateTime | End time with inclusive boundary, if not ongoing |
| - class | 0..1 | Not Used | Coding | Classification of the encounter Binding (extensible): Classification of the encounter ActEncounterCode |
| - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - classHistory | 0..* | Not Used | BackboneElement | List of past encounter classes |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - class | 1..1 | Not Used | Coding | Classification of the encounter Binding (extensible): Classification of the encounter ActEncounterCode |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - period | 1..1 | Not Used | Period | The time that the episode was in the specified class Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - type | 0..* | Not Used | CodeableConcept | Specific type of encounter Binding (example): The type of encounter EncounterType |
| - - coding | 0..1 | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..* | Not Used | Coding | Code defined by a terminology system Binding (extensible): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient’s record). CareConnect-EncounterType-1 |
| - - - extension (snomedCTDescriptionID) | 0..1 | Not Used | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
| - - - system | 1..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 1..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - priority | 0..1 | Not Used | CodeableConcept | Indicates the urgency of the encounter Binding (example): Indicates the urgency of the encounter. v3 Code System ActPriority |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - subject | 0..1 | Not Used | Reference | The patient ro group present at the encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Group | |||
| Not Used | CareConnect-Patient-1 | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - episodeOfCare | 0..* | Not Used | Reference | Episode(s) of care that this encounter should be recorded against Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | EpisodeOfCare | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - incomingReferral | 0..* | Not Used | Reference | The ReferralRequest that initiated this encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | ReferralRequest | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - participant | 0..* | Not Used | BackboneElement | List of participants involved in the encounter |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - type | 0..2 | Not Used | CodeableConcept | Role of participant in encounter Binding (extensible): Role of participant in encounter ParticipantType There will be up to two instances of this element, the first carries a reference to the responsible clinical using the Practitioner resource and the second a reference to the person accompanying the patient using the relatedPerson resource |
| - - - coding | 1..1 | Not Used | Coding | Code defined by a terminology system There will be one instance of the coding for each instance of type |
| - - - - system | 1..1 | Not Used | Uri | Identity of the terminology system This MUST contain the value 'http://hl7.org/fhir/ValueSet/encounter-participant-type' |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system The Responsible Clinician will use a code of 'CON' The Person accompanying patient will use a code of 'ESC' |
| - - - - display | 1..1 | Not Used | String | The Responsible Clinician will use a display of 'consultant' The Person accompanying patient will use a code of 'escort' |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - period | 0..1 | Not Used | Period | Period of time during the encounter that the participant participated Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - individual | 1..1 | Not Used | Reference | Persons involved in the encounter other than the patient Constraint (ref-1): SHALL have a contained resource if a local reference is provided This MUST be a reference to either the Practitioner or RelatedPerson resource |
| Not Used | RelatedPerson | The person accompanying the patient. This MUST use the RelatedPerson resource. See RelatedPerson resource for information on how to populate the resource. |
||
| Not Used | CareConnect-Practitioner-1 | The responsible clinician for the encounter. This MUST use the CareConnect Practitioner profile. See Practitioner resource for information on how to populate the resource. |
||
| - - - reference | 1..1 | Not Used | String | Literal reference, Relative, internal or absolute URL A reference to the RelatedPerson resource or the Practitioner resource included in the Assessment scales list |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - appointment | 0..1 | Not Used | Reference | The appointment that scheduled this encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Appointment | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - period | 0..1 | Not Used | Period | The start and end time of the encounter Constraint (per-1): If present, start SHALL have a lower value than end |
| - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary The date and time of admission Mapping to Maternity data item = 'Date and Time of admission'. |
| - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - length | 0..1 | Not Used | Duration | Quantity of time the encounter lasted (less time absent) Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (drt-1): There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. |
| - - value | 0..1 | Not Used | Decimal | Numerical value (with implicit precision) |
| - - comparator | 0..1 | Not Used | Code | < : <= : >= : > - how to understand the value Binding (required): How the Quantity should be understood and represented. QuantityComparator |
| - - unit | 0..1 | Not Used | String | Unit representation |
| - - system | 0..1 | Not Used | Uri | System that defines coded unit form |
| - - code | 0..1 | Not Used | Code | Coded form of the unit |
| - reason | 0..1 | Not Used | CodeableConcept | Reason the encounter takes place (code) Binding (preferred): Reason why the encounter takes place. Encounter Reason Codes The Assessment scales encounter does not use the preferred value set but uses SNOMED CT concepts instead |
| - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Not Used | Coding | Code defined by a terminology system A concept from the Care planning health issues simple reference set See here for further information Note this reference set MAY be extnded as required by the sending system |
| - - - extension (snomedCTDescriptionID) | 0..1 | Not Used | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
| - - - system | 1..1 | Not Used | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system A SNOMED CT from the Care planning health issues simple reference set as defined above |
| - - - display | 1..1 | Not Used | String | Representation defined by the system The display associated with the SNOMED CT concept. This SHOULD be the preferred term |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept This MAY be used where a suitable coded concept is not available to the sending system |
| - diagnosis | 0..* | Not Used | BackboneElement | The list of diagnosis relevant to this encounter |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - condition | 1..1 | Not Used | Reference | Reason the encounter takes place (resource) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Procedure-1 | |||
| Not Used | CareConnect-Condition-1 | |||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - - role | 0..1 | Not Used | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding (preferred): The type of diagnosis this condition represents DiagnosisRole |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - rank | 0..1 | Not Used | positiveInt | Ranking of the diagnosis (for each role type) |
| - account | 0..* | Not Used | Reference | The set of accounts that may be used for billing for this Encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Account | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - hospitalization | 0..1 | Not Used | BackboneElement | Details about the admission to a healthcare service |
| - - extension (admissionMethod) | 0..1 | Not Used | Extension-CareConnect-AdmissionMethod-1 | An extension to the Encounter resource to record how a Patient was admitted to hospital. Constraint (ext-1): Must have either extensions or value[x], not both An extension to the Encounter resource See Admission method extension for information on how to populate this extension to the resource. Mapping to Maternity data item = 'Reason for Admission'. |
| - - extension (dischargeMethod) | 0..1 | Not Used | Extension-CareConnect-DischargeMethod-1 | An extension to the Encounter resource to record the method of discharge from hospital. Constraint (ext-1): Must have either extensions or value[x], not both |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - preAdmissionIdentifier | 0..1 | Not Used | Identifier | Pre-admission identifier |
| - - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known . IdentifierUse |
| - - - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes |
| - - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - - system | 1..1 | Not Used | Uri | The namespace for the identifier value |
| - - - value | 1..1 | Not Used | String | The value that is unique |
| - - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-1 | |||
| - - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - - origin | 0..1 | Not Used | Reference | The location from which the patient came before admission Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Location-1 | |||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - - admitSource | 0..1 | Not Used | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. CareConnect-SourceOfAdmission-1 Maternity Data set mapping = 'Source of Admission' |
| - - - coding | 0..1 | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 1..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system This MUST contain the value 'https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SourceOfAdmission-1' |
| - - - - display | 1..1 | Not Used | String | Representation defined by the system This MUST contain a code from the stated ValueSet |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - reAdmission | 0..1 | Not Used | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding (example): The reason for re-admission of this hospitalization encounter. v2 Re-Admission Indicator |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - - coding (snomedCT) | 0..1 | Not Used | Coding | Code defined by a terminology system |
| - - - - extension (snomedCTDescriptionID) | 0..1 | Not Used | Extension-coding-sctdescid | The SNOMED CT Description ID for the display Constraint (ext-1): Must have either extensions or value[x], not both |
| - - - - system | 1..1 | Not Used | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 1..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - dietPreference | 0..* | Not Used | CodeableConcept | Diet preferences reported by the patient Binding (extensible): Medical, cultural or ethical food preferences to help with catering requirements. Diet |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - specialCourtesy | 0..* | Not Used | CodeableConcept | Special courtesies (VIP, board member) Binding (preferred): Special courtesies SpecialCourtesy |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - specialArrangement | 0..* | Not Used | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding (preferred): Special arrangements SpecialArrangements |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - destination | 0..1 | Not Used | Reference | Location to which the patient is discharged Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Location-1 | |||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - - dischargeDisposition | 0..1 | Not Used | CodeableConcept | Category or kind of location after discharge Binding (example): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. CareConnect-DischargeDestination-1 |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - location | 0..1 | Required | BackboneElement | List of locations where the patient has been |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - location | 1..1 | Mandatory | Reference | Location the encounter takes place Constraint (ref-1): SHALL have a contained resource if a local reference is provided The site code of the location where teh vaccination was administered. |
| Mandatory | CareConnect-Location-1 | “The location This MUST use the CareConnect Location profile. See Location resource for information on how to populate the resource.” |
||
| - - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the Location resource included in the Vaccination list |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - - status | 0..1 | Not Used | Code | planned : active : reserved : completed Binding (required): The status of the location. EncounterLocationStatus |
| - - period | 0..1 | Not Used | Period | Time period during which the patient was present at the location Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - serviceProvider | 0..1 | Not Used | Reference | The custodian organization of this Encounter record Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-1 | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - partOf | 0..1 | Not Used | Reference | Another Encounter this encounter is part of Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Encounter-1 | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
Mapping for Vaccination Practitioner
The vaccination details has reference(s) to the Practitioner resource. This means that any exchange of the vaccination details heading data must also include the [Practitioner Details
Mapping for Vaccination Practitioner Role
The vaccination details has reference(s) to the Practitioner Role resource. This means that any exchange of the vaccination details heading data must also include the [Practitioner Role Details
Mapping for Vaccination Location
The vaccination details has reference(s) to the Location resource. This means that any exchange of the vaccination details heading data must also include the [Location Details