Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Encounter

Guidance for populating the Encounter resource for consultations

Encounter elements

id

Data type: Id Optionality: Mandatory Cardinality: 1..1

The logical identifier of the Encounter resource.

meta.profile

Data type: uri Optionality: Mandatory Cardinality: 1..1

The Encounter profile URL.

identifier

Data type: Identifier Optionality: Mandatory Cardinality: 1..*

This is for business identifiers.

This is sliced to include a cross-care setting identifier which MUST be populated. The codeSystem for this identifier is https://fhir.nhs.uk/Id/cross-care-setting-identifier.

status

Data type: Code Optionality: Mandatory Cardinality: 1..1

Fixed value of finished.

Existing vocabulary is driven by use of Encounter for appointment style encounters rather than provision of consultation context. Hence, use most appropriate value from limited set available.

Some systems allow consultations to be assigned a draft or incomplete status, but this status is not conveyed in GP Connect as the information recorded in such consultation is still treated as authoritative by the source systems.

type

Data type: CodeableConcept Optionality: Mandatory Cardinality: 1..1

Carries the consultation type as displayed by system via the CodeableConcept type.text attribute.

TO DO - rule a mapping to a SNOMED CT vocabulary in or out

subject

Data type: Reference(Patient) Optionality: Mandatory Cardinality: 1..1

Reference to Patient resource representing the patient against whom the source consultation/encounter was recorded.

participant

Data type: BackboneElement Optionality: Mandatory Cardinality: 0..*

This MUST be populated with the Reference(Practitioner) of the person that recorded the consultation on the system.

Where there are additional participants, will always be populated with at least one participant.individual Reference(Practitioner) with participant.type value of PPRF from the vocabulary. This should reference a Practitioner resource representing the individual with primary attribution for the consultation/encounter (usually the single primary attributed user shown in system journals or other views).

Other participants, such as registrars, trainees or other parties present, may be referenced but with a participation type of PART.

No other values of participation type should be used.

The authorship of the consultation/encounter - that is, the actual user who entered the information on the system should be expressed via List.source.

appointment

Data type: Reference(Appointment) Optionality: Required Cardinality: 0..*

period

Data type: Period Optionality: Required Cardinality: 0..1

If recorded, period.start is mandatory and should be populated with the displayed consultation date and time.

period.end should be populated where the encounter end date and time is known or calculated and populated where the duration is known.

The audit trail date time of the consultation is carried by the associated consultation list via List.date.

The period attribute may be omitted where the effective/clinical date for the consultation on the source system is not recorded (for example, an unknown date and time).

length

Data type: Duration Optionality: Required Cardinality: 0..1

Specifies the length of the consultation. Should be calculated and populated where an end time for the consultation is known.

location

Data type: Reference(Location) Optionality: Required Cardinality: 0..*

References an instance of the Location resource that provides more detail on where the consultation/encounter took place - for example, branch surgery.

location.status and location.period are not used.

serviceProvider

Data type: Reference(Organization) Optionality: Required Cardinality: 0..1

Reference to the responsible organisation for the consultation/encounter.

Elements not used by GP Connect

The following elements SHALL NOT be populated.

statusHistory

Data type: BackboneElement

Not used.

class

Data type: Coding

Not used.

classHistory

Data type: BackboneElement

Not used.

priority

Data type: CodeableConcept

Not used.

episodeOfCare

Data type: Reference(EpisodeOfCare)

The current scope of GP Connect excludes the episode of care resource.

incomingReferral

Data type: Reference(ReferralRequest)

The current scope of GP Connect excludes inbound referrals.

reason

Data type: CodeableConcept

The reason for the consultation will be associated to the appointment.

diagnosis

Data type: BackboneElement

The diagnosis will be associated to the consultation via the list resource.

account

Data type: Reference(Account)

Not used.

hospitalization

Data type: BackboneElement

Not used.

partOf

Data type: Reference(Encounter)

Not used.


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