Publisher API HL7 Segments - Revision history

SimonMeredith: Changes to PID:18 from NWL to ensure NWL use with Millennium sources is documented and the actual relationship with PV1:19 is shown

2022-10-27T09:04:01Z

Changes to PID:18 from NWL to ensure NWL use with Millennium sources is documented and the actual relationship with PV1:19 is shown

@@ Line 65: / Line 65: @@
 === Overview ===
 The MSH segment defines the intent, source, destination, and some specifics of the syntax of a message
 === Definition ===
@@ Line 511: / Line 538: @@
 |C
 |N
-|Though officially this field is intended to capture account number it has been repurposed in DDS. It is used to carry the identifier for the episode of care. Simplistically an episode of care encapsulates all of the encounters that a patient may have with a healthcare organisation from the point of referral to the point of discharge.
+|This field is used by DDS as the identifier for the episode of care if the PV1.19 field is not populated. If the PV1.19 field is populated then PID:18 may be locally repurposed (eg. at NWL it is used to supply HIE with the FIN number for de-duplication of Millennium sourced visits) An episode of care encapsulates all of the encounters that a patient has with a healthcare organisation from the point of referral to the point of discharge. If no PV1 segment accompanies this PID segment then PID:18 should not be populated
-If the publisher does not have the concept of episode of care then instead this MUST be the same value as that found in PV1.19 - Visit number.
+|Example 1 (PV1 present and PID:18 populated with fin number):
-If no PV1 segment accompanies this PID segment then PID:18 should not be populated
+MSH|^~\&|CERNER|RQM|DISCOVERY|COMMUNITY|20220706093029||ADT^A28|Q1128670316T1226604112X162958A1148|P|2.3
 |-
 |PID:22 - Ethnic group

SimonMeredith: Changes to MRG:1, PID:3, EVN:6 - from Mike Taylor (Imperial)

2022-04-28T13:05:54Z

Changes to MRG:1, PID:3, EVN:6 - from Mike Taylor (Imperial)

← Older revision		Revision as of 13:05, 28 April 2022
Line 266:		Line 266:
	\|EVN:6.1		\|EVN:6.1
	\|TS		\|TS
	\|O		\|R
	\|N		\|N
	\|This field contains the date/time that the event actually occurred. For example, on a transfer (A02 (transfer a patient)), this field ~~would~~ contain the date/time the patient was actually transferred. On a cancellation event, this field should contain the date/time that the event being ~~canceled~~ occurred.		\|This field contains the date/time that the event actually occurred. For example, on a transfer (A02 (transfer a patient)), this field must contain the date/time the patient was actually transferred. On a cancellation event, this field should contain the date/time that the event being cancelled occurred.
	\|		\|
	\|}		\|}
Line 299:		Line 299:
	\| -		\| -
	\|R		\|R
	\|N		\|Y
	\|Patient Identifier List~~. This list must~~ include ~~at least both of~~ the ~~following~~ (~~in order~~) -		\|Patient Identifier List to include

			Always:

			* the patient's main local (to the publisher) identifier

			Optionally:

	* ~~the patient's local (to the publisher) identifier. In this instance the assigning authority (PID:3.4) must be "MRN"~~		* alternative MRNs
	*the patient's NHS number~~. In this instance the assigning authority (PID:3.4) must be "NHS"~~		* the patient's NHS number
	\|		\|
	\|-		\|-
Line 316:		Line 322:
	\|ST		\|ST
	\|R		\|R
	\|N		\|Y
	\|Assigning authority		\|Assigning authority
	\|
			* "MRN" - for the patient's main local (to the publisher) identifier
			* "ALT_MRN" - for alternative MRNs
			* "NHS" - for NHS Number
			\|<nowiki>PID\|1\| \|01529577^^^MRN~4111111998^^^NHS~E02055831^^^ALT_MRN~M2600001^^^ALT_MRN</nowiki>
	\|-		\|-
	\| rowspan="5" \|PID:5 - Patient Name		\| rowspan="5" \|PID:5 - Patient Name
Line 629:		Line 639:
	\|-		\|-
	\|MRG:1 - Prior Patient Identifier List		\|MRG:1 - Prior Patient Identifier List
			\| -
			\| -
			\| -
			\| -
			\|Patient Identifier List to include

			Always

			* the patient's main local (to the publisher) identifier

			Optionally

			* alternative MRNs
			* the patient's NHS number
			\|
			\|-
			\|
	\|MRG:1.1		\|MRG:1.1
	\| CX		\|CX
			\|R
			\|Y
			\|The patient's identifier
			\|
			\|-
			\|
			\|MRG:1.4
			\|CX
	\|R		\|R
	\|N		\|N
	\|~~MUST only contain one value -~~ the patient's local (to the publisher) identifier.		\|Assigning authority

			* “MRN” – for the patient's main local (to the publisher) identifier
			* “ALT_MRN” – for alternative MRNs
			* “NHS” for NHS number
	\|		\|
	\|-		\|-

Sophie: Latest Version

2022-01-10T13:34:50Z

Latest Version

Show changes

Will Weatherill: /* Definition */

2021-10-22T11:34:32Z

Definition

← Older revision		Revision as of 11:34, 22 October 2021
Line 472:		Line 472:
	\|O		\|O
	\|N		\|N
	\|Primary language. Allowed values are ~~from [https://datadictionary.nhs.uk/attributes~~/~~language_code.html LANGUAGE CODE]~~		\|<nowiki>Primary language. Allowed values are child concepts of the SNOMED CT World Languages concept - 297289008 \| World languages (qualifier value) \|</nowiki>
	\|		\|
	\|-		\|-

Will Weatherill: /* Reference range */

2021-10-21T10:24:33Z

Reference range

← Older revision		Revision as of 10:24, 21 October 2021
Line 1,290:		Line 1,290:
	\| -		\| -
	\|"POS"		\|"POS"
	\|}~~Each AL1 segment describes a single patient allergy.~~		\|}<br />

Will Weatherill: /* Definition */

2021-10-21T10:24:17Z

Definition

← Older revision		Revision as of 10:24, 21 October 2021
Line 1,291:		Line 1,291:
	\|"POS"		\|"POS"
	\|}Each AL1 segment describes a single patient allergy.		\|}Each AL1 segment describes a single patient allergy.

	~~=== Definition ===~~
	~~{\| class="wikitable"~~
	~~!Field~~
	~~!Component~~
	~~!Data Type~~
	~~!Optionality~~
	~~!Repeating~~
	~~!Description~~
	~~!Example~~
	\|-
	~~\|AL1:2 - Allergy type~~
	~~\|AL1:2.1~~
	~~\|IS~~
	\|O
	\|N
	~~\|Allowed values are from table [[Publisher API Code Sets#0127-AllergenType\|0127-AllergenType]]~~
	\|
	\|-
	~~\| rowspan="4" \|AL1:3 - Allergy code/description~~
	~~\| -~~
	~~\| -~~
	\|R
	\|N
	\|
	\|
	\|-
	~~\|AL1:3.1~~
	~~\|ST~~
	\|O
	\|N
	~~\|Allergy ID.~~
	\|
	\|-
	~~\|AL1:3.2~~
	~~\|ST~~
	\|C
	\|N
	~~\|Allergy Name. If AL1:3.1 is not provided then Allergy name is required~~
	\|
	\|-
	~~\|AL1:3.3~~
	~~\|ST~~
	\|C
	\|N
	~~\|Allergy coding system. If AL1:3.1 is provided then Allergy coding system is required~~
	\|
	\|-
	~~\|AL1:4 - Allergy severity~~
	~~\|AL1:4.1~~
	~~\|IS~~
	\|O
	\|N
	~~\|Allowed values are from table [[Publisher API Code Sets#0128-AllergySeverity\|0128-AllergySeverity]]~~
	\|
	\|-
	~~\|AL1:5 - Allergy reaction~~
	~~\|AL1:5.1~~
	~~\|ST~~
	\|O
	\|N
	\|
	\|
	\|-
	~~\|AL1:6 - Allergy identification date~~
	~~\|AL1:6.1~~
	~~\|DT~~
	\|O
	\|N
	\|
	\|
	\|}

Will Weatherill at 10:24, 21 October 2021

2021-10-21T10:24:02Z

← Older revision		Revision as of 10:24, 21 October 2021
Line 465:		Line 465:
	\|O		\|O
	\|N		\|N
	\|Primary language. This should be the ISO 639-1 code.		\|Primary language. This should be the ISO 639-1 code or one of the five communication method extensions defined in the NHS Data Dictionary code set.
	\|		\|
	\|-		\|-
Line 472:		Line 472:
	\|O		\|O
	\|N		\|N
	\|Primary language. Allowed values are from ~~table~~ [~~[Publisher API Code Sets#0296-PrimaryLanguage\|0296-PrimaryLanguage]~~]		\|Primary language. Allowed values are from [https://datadictionary.nhs.uk/attributes/language_code.html LANGUAGE CODE]
	\|		\|
	\|-		\|-
Line 480:		Line 480:
	\|O		\|O
	\|N		\|N
	\|Religion. Allowed values are from ~~table~~ [~~[Publisher_API_Code_Sets#DDS-Religion\|DDS-Religion]~~]		\|Religion. Allowed values are from [https://datadictionary.nhs.uk/attributes/religious_or_other_belief_system_affiliation_code.html RELIGIOUS OR OTHER BELIEF SYSTEM AFFILIATION CODE]
	\|		\|
	\|-		\|-
Line 507:		Line 507:
	\|O		\|O
	\|N		\|N
	\|Ethnicity identifier. Allowed values are from ~~table~~ [~~[Publisher API Code Sets#0189-EthnicGroup\|0189-EthnicGroup]~~]		\|Ethnicity identifier. Allowed values are from [https://datadictionary.nhs.uk/data_elements/ethnic_category.html?hl=ethnicity ETHNIC CATEGORY]
	\|		\|
	\|-		\|-
Line 708:		Line 708:
	\|O		\|O
	\|N		\|N
	\|Allowed values are from ~~table~~ [~~[Publisher API Code Sets#0007-AdmissionType\|0007-AdmissionType]~~]		\|Allowed values are from [https://datadictionary.nhs.uk/attributes/admission_method.html ADMISSION METHOD]
	\|		\|
	\|-		\|-
Line 788:		Line 788:
	\|R		\|R
	\|N		\|N
	\|Allowed values are from ~~table~~ [~~[Publisher API Code Sets#0069-HospitalService\|0069-HospitalService]~~]		\|Allowed values are from [https://datadictionary.nhs.uk/attributes/treatment_function_code.html TREATMENT FUNCTION CODE]
	\|		\|
	\|-		\|-
Line 796:		Line 796:
	\|O		\|O
	\|N		\|N
	\|Allowed values are from ~~table~~ [~~[Publisher_API_Code_Sets#DDS-AdmissionSource\|DDS-AdmissionSource]~~]		\|Allowed values are from [https://datadictionary.nhs.uk/attributes/source_of_admission.html SOURCE OF ADMISSION]
	\|		\|
	\|-		\|-
Line 820:		Line 820:
	\|O		\|O
	\|N		\|N
	\|Allowed values are from ~~table~~ [~~[Publisher API Code Sets#0112-DischargeDisposition\|0112-DischargeDisposition]~~]		\|Allowed values are from [https://datadictionary.nhs.uk/attributes/discharge_method.html DISCHARGE METHOD]
	\|		\|
	\|-		\|-
Line 828:		Line 828:
	\|O		\|O
	\|N		\|N
	\|Allowed values are from ~~table~~ [~~[Publisher API Code Sets#0113-DischargedToLocation\|0113-DischargedToLocation]~~]		\|Allowed values are from [https://datadictionary.nhs.uk/attributes/discharge_destination.html DISCHARGE DESTINATION]
	\|		\|
	\|-		\|-

Will Weatherill: /* PR1 - Procedures */

2021-10-13T11:41:25Z

PR1 - Procedures

@@ Line 1,361: / Line 1,361: @@
 |N
+|
+|
 |}

Will Weatherill: /* DG1 - Diagnosis */

2021-10-13T11:41:14Z

DG1 - Diagnosis

@@ Line 1,361: / Line 1,361: @@
 |N
+|
+|
 |}

Will Weatherill: /* Definition */

2021-10-11T16:10:07Z

Definition

← Older revision		Revision as of 16:10, 11 October 2021
Line 564:		Line 564:
	\|		\|
	\|-		\|-
	\| rowspan="4" \|PD1:4 - Patient Primary Care Provider Name and ID No		\| rowspan="5" \|PD1:4 - Patient Primary Care Provider Name and ID No
	\| -		\| -
	\| -		\| -
Line 591:		Line 591:
	\|N		\|N
	\|Given name		\|Given name
			\|
			\|-
			\|PD1:4.6
			\|ST
			\|O
			\|N
			\|Prefix
	\|		\|
	\|}		\|}