Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Admission Details List

The FHIR profiles used for the Admission Details List Structure

Heading Description

The details of the woman’s admission.

The following FHIR profiles are used to form the Admission details list structure:

The following profiles are referenced from the Admission details list structure:

Admission Details Structure

Admission details Encounter Resource Encounter Resource Encounter Resource Location Resource Location Resource Location Resource Practitioner Resource Practitioner Resource PractitionerResource 0..1 R entry.item 0..1 R entry.item 0..1 Rentry.item 0..1 R location 0..1 R location 0..1 Rlocation 0..1 R participant 0..1 R participant 0..1 Rparticipant RelatedPerson Resource RelatedPerson Resource RelatedPersonResource 0..1 R participant 0..1 R participant 0..1 Rparticipant Admission Details List Resource Admission Details List Resource Admission DetailsList Resource 1..1 M subject 1..1 M subject 1..1 Msubject Reference to Patient resource Reference to Patient resource Reference to Patient resource

Maternity Data Standard Mapping to FHIR profiles

Mapping Overview

Data Standard Element FHIR Profile Mapping FHIR Element
Date and Time of admission Encounter period.start
ODS/ORD Site Code Location identifier
Responsible Clinician Practitioner identifier and name
Patient Location Location text
Reason for admission Encounter reason
Admission Method Encounter AdmissionMethod extension
Specialty admitted to Location type
Source of Admission Encounter admitSource
Person accompanying patient RelatedPerson name

The following tables detail how to populate the FHIR resources and the mapping to the Maternity data standard.

Mapping for Admission Details List

> Level 1 List Resource > Level 2 CareConnect-List-1 > 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'
- identifier 0..* Required Identifier Business identifier
An identifier for this Admission details list
- - 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 Admission details list
- - - 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 Admission 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'
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
This MUST contain the value '886781000000108'
- - - display 0..1 Mandatory String Representation defined by the system
This MUST contain the value 'Admission details'
Mapping to Maternity data item = 'PSRB Heading Admission details'
- 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.
    Mandatory CareConnect-Patient-1 This is the subject of the Admission details List.
This MUST use the CareConnect patient profile.
See patient resource reference for information on how to populate the resource.
- - 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.
- 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.
- note 0..* Optional Annotation Comments about the list
- - author[x] 0..1 Required Reference Individual responsible for the annotation
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    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
- - 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.
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
The reference to the included Encounter resource.

Patient Reference

The Admission details list has a mandated subject reference to the Patient resource. This means that any exchange of the Admission details heading data must also include the Patient demographics List.

Mapping for Admission Details 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'
- identifier 0..* Required Identifier Identifier(s) by which this encounter is known
An identifier for this Encounter
- - 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 Encounter
- 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'
- participant 0..* Required BackboneElement List of participants involved in the encounter
- - type 0..2 Required 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 clinician using the Practitioner resource and the second a reference to the person accompanying the patient using the RelatedPerson resource
- - - coding 1..1 Mandatory Coding Code defined by a terminology system
There will be one instance of the coding for each instance of type
- - - - system 1..1 Mandatory Uri Identity of the terminology system
This MUST contain the value 'http://hl7.org/fhir/ValueSet/encounter-participant-type'
- - - - code 1..1 Mandatory 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 Mandatory String The Responsible Clinician will use a display of 'consultant'
The Person accompanying patient will use a code of 'escort'
- - individual 1..1 Mandatory 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
    Required RelatedPerson The person accompanying the patient.
This MUST use the RelatedPerson resource.
See RelatedPerson resource for information on how to populate the 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 1..1 Mandatory String Literal reference, Relative, internal or absolute URL
A reference to the RelatedPerson resource or the Practitioner resource included in the Admission details list
- period 0..1 Required 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 Required dateTime Starting time with inclusive boundary
The date and time of admission
Mapping to Maternity data item = 'Date and Time of admission'.
- reason 0..1 Required CodeableConcept Reason the encounter takes place (code)
Binding (preferred): Reason why the encounter takes place. Encounter Reason Codes
The Admission details encounter does not use the preferred value set but uses SNOMED CT concepts instead Mapping to Maternity data item = 'Reason for Admission'.
- - coding (snomedCT) 0..1 Required 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 extended as required by the sending system
- - - system 1..1 Required Uri Identity of the terminology system
The element MUST contain the value 'http://snomed.info/sct'
- - - code 1..1 Required 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 Required String Representation defined by the system
The display associated with the SNOMED CT concept. This SHOULD be the preferred term
- - text 0..1 Required String Plain text representation of the concept
This MAY be used where a suitable coded concept is not available to the sending system
- hospitalization 0..1 Required BackboneElement Details about the admission to a healthcare service
- - extension (admissionMethod) 0..1 Required 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 = 'Admission Method'.
- - admitSource 0..1 Required 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
Mapping to Maternity data item = 'Source of Admission'.
- - - coding 0..1 Required Coding Code defined by a terminology system
- - - - system 1..1 Mandatory Uri Identity of the terminology system This MUST contain the value 'https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SourceOfAdmission-1'
- - - - code 1..1 Mandatory Code Symbol in syntax defined by the system
This MUST contain a code from the stated CodeSystem.
- - - - display 1..1 Mandatory String Representation defined by the system
- location 0..1 Required BackboneElement List of locations where the patient has been
- - 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 unit to which the person was admitted
    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 Admission details list

Mapping for Admission Details RelatedPerson

The admission details has reference(s) to the related person resource. This means that any exchange of the admission details heading data must also include the Related Person Details.

Mapping for Admission Details Practitioner

The admission details has reference(s) to the Practitioner resource. This means that any exchange of the admission details heading data must also include the Practitioner Details.

Mapping for Admission Location

The admission details has reference(s) to the Location resource. This means that any exchange of the admission details heading data must also include the Location Details.

Mapping for Admission Details Admission Method Extension

> Level 1 Extension > Level 2 Extension-CareConnect-AdmissionMethod-1 > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Implementation
Extension     An extension to the Encounter resource to record how a Patient was admitted to hospital.
Constraint (ele-1): All FHIR elements must have a @value or children
Constraint (ext-1): Must have either extensions or value[x], not both
- id 0..1 Optional String xml:id (or equivalent in JSON)
- url 1..1 Mandatory Uri Identifies The Meaning Of The Extension Fixed Value = ‘https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1’
- valueCodeableConcept 1..1 Mandatory CodeableConcept The method of admission to a Hospital Provider Spell.
Binding (required): The method of admission to a Hospital Provider Spell.
Admission Method

Admission Details Heading Example

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated