https://www.hl7.org/fhir/STU3/operations.html

https://www.hl7.org/fhir/STU3/operationdefinition.html

https://www.hl7.org/fhir/STU3/operation-messageheader-process-message.html

Status

In development. API spec subject to change.

Overview

PKB only support asynchronous message processing, so a URL parameter of "async=true" must be provided.

PKB will outline a Message Definition for each event that we support. Some behaviour will be common to all messages as part of the general $process-message specification. Each message will have its own business logic rules defined in the corresponding message definition.

Interaction	HTTP	URL	Supported Parameters	Permitted User Types	Description	Examples
operation	POST	/$process-message	async=true. Required.	System User	Submit message to PKB for processing.	/$process-message?async=true

Message Definition: Create or Update Patient

Server behaviour

FHIR	PKB	Notes
Bundle.identifier	identifier: Identifier value. A sender-assigned UUID.
Bundle.type	"message"
Bundle.entry[0]: BackboneElement	resource: MessageHeader
MessageHeader.id	id. A sender-assigned UUID for the message.
MessageHeader.event	event system = "http://fhir.patientsknowbest.com/codesystem/message-event" code = "create-or-update-patient"
MessageHeader.destination	destination endpoint. The absolute URL of the PKB $process-message endpoint.
MessageHeader.timestamp	timestamp
MessageHeader.source	source endpoint. This must be set to a pre-agreed value configured for the sender's API Client ID. This is the location to which PKB will send the asynchronous response.
Bundle.entry[1]: BackboneElement	resource: Patient
Patient.meta	meta tag system = "https://fhir.nhs.uk/Id/ODS-Code" code. The ODS code of the source organisation for this demographic update.
Patient.identifier	identifier: Identifier extension url = "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1" valueCodeableConcept coding system = "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1" code = "01" value. The NHS number of the patient. system = "https://fhir.nhs.uk/Id/nhs-number"
Patient.name	name: HumanName family = [[User.Family Name]] given[0] = [[User.Given Name]] prefix[0] = [[User.Title]]
Patient.telecom	telecom: ContactPoint system = "email" value = [[Contact.Value]]
Patient.telecom	telecom: ContactPoint system = "phone" value = [[Patient.Phone]]
Patient.gender	[[Patient.Gender]] [[Patient.Gender]] code mappings (FHIR → PKB): unknown → UNKNOWN male → MALE female → FEMALE other → INDETERMINATE
Patient.birthDate	[[Patient.Date of Birth]]
Patient.deceased[x]	<conditional> If the patient is recorded as dead and the death timestamp is known: deceasedDateTime = [[Patient.Death Timestamp]] Else if the patient is recorded as dead but a death timestamp has not been recorded: deceasedBoolean = true Else deceasedBoolean = false
Patient.address	address: Address line[0] = [[Patient.Address Line 1]] line[1] = [[Patient.Address Line 2]] city = [[Patient.City]] state = [[Patient.State]] postalCode = [[Patient.Postal Code]] country = [[Patient.Country]]