Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Distribution List Section

A list of recipients of the document

Distribution List Section Content

The Distribution list section carries a list of recipients of the document. PRSB Elements should be formatted as subheadings in any HTML sent.

The document may be sent to any number of recipients, however all recipients should be included in the distribution list to allow individual recipients to know who else has received a copy.

Section Description Card. MRO* FHIR Target and Guidance
Distribution list A list of other individuals to receive a copy of this communication. 0 to 1 R Carried in the CodeableConcept of Composition.section.code FHIR element.
PRSB Element Description Card. MRO* FHIR Target and Guidance
Name If the communication is being sent to a named individual, then this is the name of the recipient, preferably in a structured format. An identifier for the individual, for example GMC code (for a GP), or an SDS identifier, a NHS Number (for a patient) will be sent alongside the name. 0 to 1 R Names may be entered as the communication is being created or sourced from the hospital system. Patient names may be from the Patient Demographic Service. Text and carried in the FHIR element Practitioner.name or Patient.name. The identifier will be carried in the FHIR element Practitioner.identifier or Patient.identifier.
Role If the communication is being sent to either a named individual, or to a non-named person with a specific role, then this is the role of the recipient. 0 to 1 R Role may be entered as the communication is being created or sourced from the hospital system. This may be a role defined in the National Workforce data set (see the NHS Data Dictionary Job Role Code). Text and carried in the PractitionerRole.code
Grade The recipient's grade. 0 to 1 O The grade of the recipient, if known by the sending institution, otherwise omitted. Text only
Organisation name The name of the organisation the recipient is representing or the organisation named as the receiving organisation. An identifier for the organisation will be sent alongside the name. 0 to 1 R Organisation name in text and carried in the FHIR element Organization.name and identifier (which MUST NOT be in carried in the text), taken from the Organisation Data Service (ODS)) and carried in the FHIR element Organization.identifier
Team Team that the recipient belongs to in the context of receiving this message, or the team acting as the recipient. 0 to 1 O There are no national codes for teams, so this value would have to be agreed locally, and entered as free text only.
Relationship to subject The relationship of the receiver to the patient, where the receiver has a personal relationship to the patient, for example, carer or parent 0 to 1 O Personal relationships as documented in the NHS Data Dictionary Person Relationship Type (This value set is now retired carried as text and where possible mapped to the FHIR ValueSet relatedperson-relationshiptype and carried a code in the FHIR element RelatedPerson.relationship
* M=Mandatory R=Required O=Optional

Example Distribution List Section

Tags: fhir

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