Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Discharge Details List

The FHIR profiles used for the Discharge details List

Heading Description

The details of the woman’s discharge.

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

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

Discharge Details Structure

Page-1 Reference from Discharge details List to Encounter Location Resource Location Resource LocationResource Reference from Encounter to Location Encounter Resource Encounter Resource Encounter Resource Practitioner Resource Practitioner Resource PractitionerResource Reference from Encounter to Practitioner 0..* R entry.item 0..* R entry.item 0..* Rentry.item PractitionerRole Resource PractitionerRole Resource PractitionerRoleResource Reference from PractitionerRole to Practitioner 0..1 R location 0..1 R location 0..1 Rlocation 0..1 R participant 0..1 R participant 0..1 Rparticipant 0..1 R practitioner 0..1 R practitioner 0..1 Rpractitioner Discharge Details List Resource Discharge Details List Resource Discharge 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 Reference from Discharge details List to Patient

Maternity Data Standard Mapping to FHIR profiles

Mapping Overview

Data Standard Element FHIR Resource Mapping FHIR Element
Date and time of discharge Encounter period.end
ODS/ORD Site Code Location identifier
Responsible Clinician Practitioner name
Discharging Speciality/Department PractitionerRole specialty
Discharge method Encounter DischargeMethod extension
Discharge destination Encounter hospitalization.dischargeDisposition
Discharge address Location address/identifier

Mapping for Discharge 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 Discharge details List

- - system 1..1 Required Uri The namespace for the identifier value
The system from which the identifier came
- - value 1..1 Mandatory String The value that is unique
A value for the identifier
- - assigner 0..1 Optional Reference Organization that issued id (may be just text)
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Organization-1  
- - - reference 0..1 Optional String Literal reference, Relative, internal or absolute URL
- - - identifier 0..1 Optional Identifier Logical reference, when literal reference is not known
- - - display 0..1 Optional String Text alternative for the resource
- 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 'Discharge details'
Mapping to Maternity data item = 'PSRB Heading Discharge 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 'tbc'
- - - display 0..1 Mandatory String Representation defined by the system
This MUST contain the value 'Discharge details'
Mapping to Maternity data item = 'PSRB Heading Discharge 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 Discharge 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 created or updated
- note 0..* Optional Annotation Comments about the list
- - author[x] 0..1 Optional Reference Individual responsible for the annotation
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Practitioner-1  
    Optional 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.
- - 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
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL

Patient Reference

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

Mapping for Discharge 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 Mandatory Uri The namespace for the identifier value
The system from which the identifier came
- - value 1..1 Mandatory String The value that is unique
A value for the identifier
- - assigner 0..1 Optional Reference Organization that issued id (may be just text)
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Organization-1  
- - - reference 0..1 Optional String Literal reference, Relative, internal or absolute URL
- - - identifier 0..1 Optional Identifier Logical reference, when literal reference is not known
- - - display 0..1 Optional 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
- subject 0..1 Optional Reference The patient ro group present at the encounter
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Optional CareConnect-Patient-1  
- - reference 0..1 Optional String Literal reference, Relative, internal or absolute URL
- - identifier 0..1 Optional Identifier Logical reference, when literal reference is not known
- - display 0..1 Optional String Text alternative for the resource
- participant 0..1 Required BackboneElement List of participants involved in the encounter
- - type 0..* Required CodeableConcept Role of participant in encounter
Binding (extensible): Role of participant in encounter ParticipantType
- - - coding 0..* Required Coding Code defined by a terminology system
- - - - system 0..1 Required Uri Identity of the terminology system
- - - - code 0..1 Required Code Symbol in syntax defined by the system
- - - - display 0..1 Required String Representation defined by the system
- - - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - - text 0..1 Optional String Plain text representation of the concept
- - period 0..1 Optional 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 Optional dateTime Starting time with inclusive boundary
- - - end 0..1 Optional dateTime End time with inclusive boundary, if not ongoing
- - individual 0..1 Required Reference Persons involved in the encounter other than the patient
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Required RelatedPerson  
    Optional CareConnect-Practitioner-1  
- - - reference 0..1 Required String Literal reference, Relative, internal or absolute URL
- - - identifier 0..1 Optional Identifier Logical reference, when literal reference is not known
- - - display 0..1 Required String Text alternative for the resource
- 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 Optional dateTime Starting time with inclusive boundary
- - end 0..1 Required dateTime End time with inclusive boundary, if not ongoing
Mapping to Digital Maternity data item='Date and time of discharge'
- - extension (dischargeMethod) 0..1 Required 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
Mapping to Digital Maternity data item='Discharge method'
- - dischargeDisposition 0..1 Required 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
Mapping to Digital Maternity data item='Discharge disposition'
- - - coding 0..1 Required Coding Code defined by a terminology system
- - - - system 0..1 Required Uri Identity of the terminology system
- - - - code 0..1 Required Code Symbol in syntax defined by the system
- - - - display 0..1 Required String Representation defined by the system
- - - - userSelected 0..1 Optional Boolean If this coding was chosen directly by the user
- - - text 0..1 Optional String Plain text representation of the concept
- 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
    Mandatory CareConnect-Location-1  
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
- - - identifier 0..1 Optional Identifier Logical reference, when literal reference is not known
- - - display 0..1 Optional String Text alternative for the resource

Mapping for Discharge Details Discharge Method Extension

> Level 1 Extension > Level 2 Extension-CareConnect-DischargeMethod-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 the method of discharge from 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-DischargeMethod-1’
- valueCodeableConcept 1..1 Mandatory CodeableConcept The method of discharge from a Hospital Provider Spell.
Binding (required): The method of discharge from a Hospital Provider Spell.
Discharge Method

Mapping for Discharge details Location

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

Mapping for Discharge details Practitioner

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

Mapping for Discharge details PractitionerRole

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

Discharge details example

Tags: fhir

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