Item | DT | Card | Conf | Description | Label |
---|
hl7:recordTarget
| | 1 … * | R | | XeHSrget |
@typeCode
| cs | 0 … 1 | F | RCT |
@contextControlCode
| cs | 0 … 1 | F | OP |
| Example | <recordTarget typeCode="RCT" contextControlCode="OP"> <patientRole classCode="PAT"> <id root="1.2.3.999" extension="__example only__"/> <addr> <streetAddressLine>HSE M CASSAR STR</streetAddressLine> <city>ISLA</city> <country>MT</country> </addr> <telecom use="HP" value="tel:+356124567891"/> <telecom use="WP" value="mailto:elif@foo.too.mt"/> <patient> <name> <family>BORG</family> <given>TANIA</given> </name> <administrativeGenderCode code="F" codeSystem="2.16.840.1.113883.5.1" displayName="Female"/> <birthTime value="19430130"/> <!-- Optional guardian information ; see example below--> <!-- Optional languageCommunication information see example below --> </patient> </patientRole></recordTarget> |
hl7:patientRole
| | 1 … 1 | M | | XeHSrget |
@classCode
| cs | 0 … 1 | F | PAT |
hl7:id
| II | 1 … * | R | Patient Identifiers: Primary Patient Identifier (Regional/National Health Id), Secondary Patient Identifier (Social/Insurance Number) | XeHSrget |
hl7:addr
| AD.IPS | 1 … * | R | The patient address. | XeHSrget |
| Constraint | When used for cross-border exchange the country address part has to be provided. |
Included | | | from 2.16.840.1.113883.10.22.11 IPS Address (DYNAMIC) |
@use
| set_cs | 0 … 1 | | |
| CONF | |
@nullFlavor
| cs | 0 … 1 | F | NI |
| Constraint | SHALL NOT have mixed content except for white space If there is no information, the nullFlavor attribute shall have a value of 'NI' and no address parts shall be present, otherwise there shall be no nullFlavor attribute, and at least one of the address parts listed below shall be present. |
| Schematron assert | role | error | |
| test | @nullFlavor or hl7:* | |
| Message | If addr is not nullflavored at least one sub element has to be provided | |
hl7:streetAddressLine
| ADXP | 0 … * | C | Subject's or Organization's Street Address Line | IPSAress |
| Schematron assert | role | error | |
| test | hl7:streetAddressLine and (hl7:city or hl7:postalCode) | |
| Message | If the address line is included either the city or the zip code has to be provided | |
hl7:city
| ADXP | 0 … 1 | C | Subject's or Organization's City | IPSAress |
hl7:postalCode
| ADXP | 0 … 1 | C | Subject's or Organization's Postal Code | IPSAress |
hl7:state
| ADXP | 0 … 1 | C | Subject's or Organization's State or Province | IPSAress |
hl7:country
| ADXP | 0 … 1 | C | Subject's Country. | IPSAress |
| Constraint | The content of this element SHALL be selected EITHER from ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300 DYNAMIC OR MAY be selected from ISO Country Alpha-3 2.16.840.1.113883.1.11.171 DYNAMIC, IF the country is not specified in ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300. |
hl7:telecom
| TEL | 1 … * | R | Patient’s telecom information : e.g. telephone number, e-mail address. | XeHSrget |
@use
| set_cs | 0 … 1 | | |
| CONF | |
@nullFlavor
| cs | 0 … 1 | F | NI |
| Constraint | If there is no information, the nullFlavor attribute shall have a value of 'NI' and the "value" and "use" attributes shall be omitted, otherwise the nullFlavor attribute shall not be present, and the "value" and "use" attributes shall be present.
|
| Example | <telecom use="HP" value="tel:+356124567891"/> |
| Example | <telecom use="WP" value="mailto:elif@foo.too.mt"/> |
| Example | <telecom nullFlavor="NI"/> |
hl7:patient
| | 1 … 1 | M | | XeHSrget |
@classCode
| cs | 0 … 1 | F | PSN |
@determinerCode
| cs | 0 … 1 | F | INSTANCE |
| Example | Japanese example (Person Name) <patient> <name use="IDE"> <family>木村</family> <given>通男</given> </name> <name use="SYL"> <family>きむら</family> <given>みちお</given> </name> <name use="ABC"> <family>KIMURA</family> <given>MICHIO</given> </name> <administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1" displayName="Male"/> <birthTime nullFlavor="UNK"/></patient> |
hl7:name
| PN | 1 … * | M | Patient Name | XeHSrget |
| Constraint | The Alphabetic representation of the name SHALL be always provided |
hl7:family
| | 1 … * | R | Patient's Family Name/Surname | XeHSrget |
hl7:given
| | 1 … * | R | Patient's Given Name | XeHSrget |
hl7:administrativeGenderCode
| CE.IPS | 1 … 1 | R | Patient's Gender | XeHSrget |
@nullFlavor
| cs | 0 … 1 | F | UNK |
| CONF | |
| Example | <administrativeGenderCode code="F" codeSystem="2.16.840.1.113883.5.1" displayName="Female"> <translation code="2" codeSystem="2.16.840.1.113883.3.129.1.2.21" codeSystemName="Cinsiyet" displayName="Kadın"/></administrativeGenderCode> |
hl7:birthTime
| TS | 1 … 1 | R | Patient's Date of Birth. The patient date of birth may be a partial date such as only the year. | XeHSrget |
hl7:guardian
| | 0 … * | R | The guardians of a patient.
Other patient contacts are described using the /ClinicalDocument/participant structure. The <associatedEntity> element defines the type of contact. | XeHSrget |
@classCode
| cs | 1 … 1 | F | GUARD |
| Example | <guardian classCode="GUARD"> <code code="AUNT" displayName="tante" codeSystem="2.16.840.1.113883.5.111"/> <addr nullFlavor="NI"/> <telecom use="MC" value="tel:+33-12345678"/> <guardianPerson> <name> <family>Curie</family> <given>Marie</given> </name> </guardianPerson></guardian> |
hl7:code
| CD.IPS | 0 … 1 | R | The relationship between the patient and the guardian or other contact may be recorded in the element. | XeHSrget |
| CONF | |
hl7:addr
| AD.IPS | 1 … * | R | | XeHSrget |
| Constraint | If there is no information, the nullFlavor attribute shall have a value of 'NI' and no address parts shall be present, otherwise there shall be no nullFlavor attribute, and at least one of the address parts listed below shall be present.
|
Included | | | from 2.16.840.1.113883.10.22.11 IPS Address (DYNAMIC) |
@use
| set_cs | 0 … 1 | | |
| CONF | |
@nullFlavor
| cs | 0 … 1 | F | NI |
| Constraint | SHALL NOT have mixed content except for white space If there is no information, the nullFlavor attribute shall have a value of 'NI' and no address parts shall be present, otherwise there shall be no nullFlavor attribute, and at least one of the address parts listed below shall be present. |
| Schematron assert | role | error | |
| test | @nullFlavor or hl7:* | |
| Message | If addr is not nullflavored at least one sub element has to be provided | |
hl7:streetAddressLine
| ADXP | 0 … * | C | Subject's or Organization's Street Address Line | IPSAress |
| Schematron assert | role | error | |
| test | hl7:streetAddressLine and (hl7:city or hl7:postalCode) | |
| Message | If the address line is included either the city or the zip code has to be provided | |
hl7:city
| ADXP | 0 … 1 | C | Subject's or Organization's City | IPSAress |
hl7:postalCode
| ADXP | 0 … 1 | C | Subject's or Organization's Postal Code | IPSAress |
hl7:state
| ADXP | 0 … 1 | C | Subject's or Organization's State or Province | IPSAress |
hl7:country
| ADXP | 0 … 1 | C | Subject's Country. | IPSAress |
| Constraint | The content of this element SHALL be selected EITHER from ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300 DYNAMIC OR MAY be selected from ISO Country Alpha-3 2.16.840.1.113883.1.11.171 DYNAMIC, IF the country is not specified in ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300. |
hl7:telecom
| TEL | 1 … * | R | Guardian’s telecom information: e.g. telephone number; e-mail address. | XeHSrget |
@use
| set_cs | 0 … 1 | | |
| CONF | |
@nullFlavor
| cs | 0 … 1 | F | NI |
| Constraint | If there is no information, the nullFlavor attribute shall have a value of 'NI' and the "value" and "use" attributes shall be omitted, otherwise the nullFlavor attribute shall not be present, and the "value" and "use" attributes shall be present.
|
hl7:guardianPerson
| | 1 … 1 | R | | XeHSrget |
hl7:name
| PN | 1 … * | R | Patient Guardian's Name | XeHSrget |
hl7:family
| ENXP | 1 … * | R | Patient Guardian's Family Name/Surname | XeHSrget |
hl7:given
| ENXP | 1 … * | R | Patient Guardian's Given Name | XeHSrget |
hl7:languageCommunication
| | 0 … * | R | | XeHSrget |
hl7:languageCode
| CS | 1 … 1 | R | Patient’s language | XeHSrget |
| Constraint | The two characters form SHALL be used when available; otherwise the three characters representation SHALL be adopted |
| CONF | |
| Example | British English <languageCode code="en-GB"/> |
| Example | Amurdak (Australia) <languageCode code="amg-AU"/> |
| Schematron assert | role | error | |
| test | matches(@code,'[a-z]{2,3}-[A-Z]{2,3}') | |
| Message | The language code SHALL be in the form nn-CC or nnn-CCC, in accordance with BCP 47 (e.g. nn is the ISO language code; CC is ISO country code) | |