The FHIR profiles used for the PDS Change of Address event message bundle

PDS Change of Address event messages are generated by the Spine and published to the NEMS when the H (usual) address of a patient is changed within their PDS record. The event message will contain the patient’s new address and their previous address as per the guidance below.

The PDS Change of Address event message is intended for the purpose of notifying subscribers that a patients address has been updated on PDS, and should be used as follows:

  • The address details contained within the event message should only be used for the purpose of determining if the subscriber should take some action as a result of the address change.
  • The address format within the event message may be different to the format of the address within PDS, due to contraints of FHIR, therefore the address received in the event message should not be used in place of PDS synchronisation.
  • Subscribers receiving the change of address event message MUST not update PDS with the address details or format received in the event message as this may result in the address flip flop issue highlighted above.

Bundle structure

Specifies mandatory referencing within the Event Message Bundle.

PDS Change of Address Bundle (open in new TAB)

The CareConnect-Patient-1 resource within the bundle will contain two addresses, one will represent the patient’s old address and one will represent the patients new address and will be identifiable by the use element within the addresses.

PDS Change of Address Message Life Cycle

The PDS Change of Address event message will always contain a messageEventType extension with value new in the MessageHeader resource. There will be no update or delete version of this event message.

If a subscriber receives multiple PDS Change of Address event messages for the same patient, the latest event message as indicated by the meta.lastUpdated element within the MessageHeader resource should be considered the source of truth for the patient’s correct address.

Onward Delivery

The delivery of the PDS Change of Address event messages to subscribers via MESH will use the following WorkflowID within the MESH control file. This WorkflowID will need to be added to the receiving MESH mailbox configuration before event messages can be received.

MESH WorkflowID CHANGEOFADDRESS_1

Resource Population Requirements and Guidance

The following requirements and resource population guidance should be followed in addition to the requirements and guidance outlined in the Generic Requirements page.

Bundle

The Bundle resource is the container for the event message and SHALL conform to the Bundle FHIR profile.

Resource Cardinality 1..1
Element Cardinality Additional Guidance
type 1..1 Fixed value: message

Event-MessageHeader-1

The MessageHeader resource included as part of the event message SHALL conform to the Event-MessageHeader-1 constrained FHIR profile and the additional population guidance as per the table below:

Resource Cardinality 1..1
Element Cardinality Additional Guidance
meta.lastUpdated 1..1 DateTime when the patient record was updated with the details included in this event message. This element should be used for message sequencing
extension(messageEventType) 1..1 Fixed value: new
event 1..1 Fixed Value: pds-change-of-address-1 (PDS Change of Address)
responsible 1..1 This will reference the source organization of the event message.
For PDS events this will be a reference to a CareConnect-Organization-1 resource within the message bundle. *
focus 1..1 This will reference the “CareConnect-Communication-1” resource which contains information relating to the event message.

CareConnect-Communication-1

The Communication resource included in the event message SHALL conform to the CareConnect-Communication-1 constrained FHIR profile and the additional population guidance as per the table below:

Resource Cardinality 1..1
Element Cardinality Additional Guidance
status 1..1 Fixed value: completed
sender 0..1 This will reference the sending organization of the event message.
For PDS events this will be a reference to a CareConnect-Organization-1 resource within the message bundle. *
subject 1..1 This will reference the patient resource representing the patient who is the subject of this event.

CareConnect-Patient-1

The patient resource included in the event message SHALL conform to the CareConnect-Patient-1 constrained FHIR profile and the additional population guidance as per the table below:

Resource Cardinality 1..1
Element Cardinality Additional Guidance
meta.versionId 1..1 This element will contain the serial change number (SCN) of the patient record within Spine at the time this event was published.
identifier 1..1 Patient NHS Number SHALL be included within the nhsNumber identifier slice
Current Address    
address.use 1..1 Fixed value: home
address.line 1..* Current address lines.

The address lines SHALL appear within the resource in the order they appear in PDS. Blank lines in the PDS address will not be included within the FHIR resource.

PDS does not differentiate City and District from other address lines, as a result it would not be reliable to extract these elements to populate the FHIR city and district elements therefore the all address lines, including city and district, will be included within the resource address.line elements.
address.postalcode 1..1 Current address post code
address.text 1..1 Text representation of the patient’s current address in full
address.period.start 1..1 The date from which the patient’s current address was valid
Previous Address    
address.use 1..1 Fixed value: old
address.line 1..* Previous address lines.

The address lines SHALL appear within the resource in the order they appeared in PDS. Blank lines in the PDS address will not be included within the FHIR resource.

PDS does not differentiate City and District from other address lines, as a result it would not be reliable to extract these elements to populate the FHIR city and district elements therefore the all address lines, including city and district, will be included within the resource address.line elements.
address.postalcode 1..1 Previous address post code
address.text 1..1 Text representation of the patient’s previous address in full
address.period.start 1..1 The date from which the patient’s previous address was valid
address.period.end 0..1 The date from which the patient’s previous address was no longer their current address

CareConnect-Organization-1

The Organization resource(s) included in the event message SHALL conform to the CareConnect-Organization-1 constrained FHIR profile and the additional population guidance as per the table below:

Resource Cardinality 1..2
Element Cardinality Additional Guidance
identifier.system 1..1 Fixed value: https://fhir.nhs.uk/Id/ods-organization-code
identifier.value 1..1 Organisation’s ODS Organization Code
name 1..1 Organisation’s Name

* Organization details may be retrieved using the ODS Lookup API as ODSAPI-Organization-1 resources. These MUST then be transformed to CareConnect-Organization-1 resources for use within the event message bundle.

NB: ‘responsible’ and ‘sender’ organisations may be the same or different organisations, therefore requiring a single or two CareConnect-Organization-1 resources within the event message bundle.

CareConnect-HealthcareService-1

The HealthcareService resource included in the event message SHALL conform to the CareConnect-HealthcareService-1 constrained FHIR profile and the additional population guidance as per the table below:

Resource Cardinality 0..1
Element Cardinality Additional Guidance
providedBy 1..1 This will reference the ‘sender’ organization of the event message.
type 1..1 Fixed value: PDS (Personal Demographics Service)
This will represent the type of service responsible for the event message. This will have a value from the ValueSet EMS-HealthcareServiceType-1

PDS Change of Address Example

<Bundle xmlns="http://hl7.org/fhir">
	<id value="236a1d4a-5d69-4fa9-9c7f-e72bf505aa5b"/>
	<meta>
		<profile value="http://hl7.org/fhir/STU3/StructureDefinition/Bundle"/>
	</meta>
	<type value="message"/>
	<!--Entry for MessageHeader with id, timestamp, event type, source, responsible/publishing organization, communication-->
	<entry>
		<fullUrl value="3cfdf880-13e9-4f6b-8299-53e96ef5ec02"/>
		<resource>
			<MessageHeader>
				<id value="3cfdf880-13e9-4f6b-8299-53e96ef5ec02"/>
				<meta>
					<versionId value="1"/>
					<lastUpdated value="2017-11-01T15:00:33+00:00"/>
					<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Event-MessageHeader-1"/>
				</meta>
				<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RoutingDemographics-1">
					<extension url="nhsNumber">
						<valueIdentifier>
							<system value="https://fhir.nhs.uk/Id/nhs-number"/>
							<value value="9912003888"/>
						</valueIdentifier>
					</extension>
					<extension url="name">
						<valueHumanName>
							<use value="official"/>
							<family value="DAWKINS"/>
							<given value="Jack"/>
						</valueHumanName>
					</extension>
					<extension url="birthDateTime">
						<valueDateTime value="2017-10-02T12:00:00+00:00"/>
					</extension>
				</extension>
				<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-MessageEventType-1">
					<valueCodeableConcept>
						<coding>
							<system value="https://fhir.nhs.uk/STU3/CodeSystem/MessageEventType-1"/>
							<code value="new"/>
							<display value="New event message"/>
						</coding>
					</valueCodeableConcept>
				</extension>
				<event>
					<system value="https://fhir.nhs.uk/STU3/CodeSystem/EventType-1"/>
					<code value="pds-change-of-address-1"/>
					<display value="PDS Change of Address"/>
				</event>
				<timestamp value="2019-11-01T15:00:00+00:00"/>
				<source>
					<contact>
						<system value="email"/>
						<value value="ssd.nationalservicedesk@nhs.net"/>
					</contact>
					<endpoint value="urn:nhs:addressing:asid:477121000323"/>
				</source>
				<responsible>
					<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/X26"/>
					<display value="NHS DIGITAL"/>
				</responsible>
				<focus>
					<reference value="urn:uuid:3f98da8c-3fe9-430e-8e7c-6edd078622f0"/>
				</focus>
			</MessageHeader>
		</resource>
	</entry>
	<!--Entry for service type within the Organization i.e. PDS-->
	<entry>
		<fullUrl value="urn:uuid:4c687299-3693-47f0-b477-562b0784d225"/>
		<resource>
			<HealthcareService>
				<id value="4c687299-3693-47f0-b477-562b0784d225"/>
				<meta>
					<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1"/>
				</meta>
				<identifier>
					<system value="https://fhir.nhs.uk/STU3/CodeSystem/EMS-HealthcareServiceType-1"/>
					<value value="PDS"/>
				</identifier>
				<providedBy>
					<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/X26"/>
					<display value="NHS DIGITAL"/>
				</providedBy>
				<type>
					<coding>
						<system value="https://fhir.nhs.uk/STU3/CodeSystem/EMS-HealthcareServiceType-1"/>
						<code value="PDS"/>
						<display value="Personal Demographics Service"/>
					</coding>
				</type>
			</HealthcareService>
		</resource>
	</entry>
	<!--Entry for communication for the event message, with reference to subject and payload-->
	<entry>
		<fullUrl value="urn:uuid:3f98da8c-3fe9-430e-8e7c-6edd078622f0"/>
		<resource>
			<Communication>
				<id value="3f98da8c-3fe9-430e-8e7c-6edd078622f0"/>
				<meta>
					<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Communication-1"/>
				</meta>
				<status value="completed"/>
				<subject>
					<reference value="urn:uuid:dffd3330-dc21-11e7-9296-cec278b6b50a"/>
					<display value="DAWKINS, Jack"/>
				</subject>
				<sent value="2019-12-01"/>
				<payload>
					<contentReference>
						<reference value="urn:uuid:dffd3330-dc21-11e7-9296-cec278b6b50a"/>
						<display value="DAWKINS, Jack"/>
					</contentReference>
				</payload>
			</Communication>
		</resource>
	</entry>
	<!--Entry for communication for the Patient with change of address detail.-->
	<entry>
		<fullUrl value="urn:uuid:dffd3330-dc21-11e7-9296-cec278b6b50a"/>
		<resource>
			<Patient>
				<id value="dffd3330-dc21-11e7-9296-cec278b6b50a"/>
				<meta>
					<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"/>
				</meta>
				<identifier>
					<extension url="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1">
						<valueCodeableConcept>
							<coding>
								<system value="https://fhir.hl7.org.uk/STU3/CareConnect-NHSNumberVerificationStatus-1"/>
								<code value="01"/>
								<display value="Number present and verified"/>
							</coding>
						</valueCodeableConcept>
					</extension>
					<system value="https://fhir.nhs.uk/Id/nhs-number"/>
					<value value="9912003888"/>
				</identifier>
				<name>
					<use value="official"/>
					<family value="DAWKINS"/>
					<given value="Jack"/>
				</name>
				<gender value="male"/>
				<birthDate value="2019-10-02">
					<extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime">
						<valueDateTime value="2019-10-02T20:12:00+00:00"/>
					</extension>
				</birthDate>
				<!--Entry for previous address.-->
				<address>
					<use value="old"/>
					<line value="3 WELLHOUSE CLOSE"/>
					<line value="WAKEFIELD"/>
					<postalCode value="WF14 0BQ"/>
					<period>
						<start value="2019-10-02"/>
						<end value="2019-11-01"/>
					</period>
				</address>
				<!--Entry for new address.-->
				<address>
					<use value="home"/>
					<line value="4 SANDMOOR DRIVE"/>
					<line value="LEEDS"/>
					<postalCode value="LS17 7DF"/>
					<period>
						<start value="2019-11-01"/>
					</period>
				</address>
			</Patient>
		</resource>
	</entry>
</Bundle>
Tags: fhir