IE Core Patient (Patient Summary) - Definitions - IE (Ireland) Core Implementation Guide v0.3.0

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

4. Patient.extension

Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 10..*

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

This element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

6. Patient.extension:birthPlace

Slice Name birthPlace

Definition

The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

Short Place of Birth for patient

Comments

HIQA PS 1.4.3 Place of birth (Required 0..1): the county (in Ireland) or city (elsewhere) of birth, carried in valueAddress.state or valueAddress.city.

Control 0..1

Type Extension(Patient Birth Place) (Extension Type: Address)

Is Modifier false

Must Support true

Summary false

8. Patient.extension:birthPlace.extension

Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

10. Patient.extension:birthPlace.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/patient-birthPlace

12. Patient.extension:birthPlace.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1
This element is affected by the following invariants: ext-1

Type Address(Address (EU)), date, Meta, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

14. Patient.extension:sex-for-clinical-use

Slice Name sex-for-clinical-use

Definition

A parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc..

Short Sex for clinical use

Control 0..*

Type Extension(Patient Sex Parameter For Clinical Use) (Complex Extension)

Is Modifier false

16. Patient.extension:gender-identity

Slice Name gender-identity

Definition

An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.

Short The individual's gender identity

Comments

HIQA PS 1.4.5 Gender cluster (Required 0..1): 1.4.5.1 Gender (coded) and 1.4.5.2 Other gender identity (valueCodeableConcept.text).

Control 0..1

Type Extension(Individual Gender Identity) (Complex Extension)

Is Modifier false

Must Support true

18. Patient.extension:pronouns

Slice Name pronouns

Definition

The pronouns to use when referring to an individual in verbal or written communication.

Short The pronouns to use when communicating about an individual.

Comments

Prohibited: not in the HIQA PS dataset.

Control 0..0

Type Extension(Individual Pronouns) (Complex Extension)

Is Modifier false

20. Patient.extension:patient-citizenship

Slice Name patient-citizenship

Definition

The patient's legal status as citizen of a country.

Short Citizenship

Control 0..*

Type Extension(Patient Citizenship) (Complex Extension)

Is Modifier false

22. Patient.extension:patient-nationality

Slice Name patient-nationality

Definition

The nationality of the patient.

Short Nationality

Comments

HIQA PS 1.4.7 Nationality (Required 0..*, coded): country of legal citizenship.

Control 0..*

Type Extension(Patient Nationality) (Complex Extension)

Is Modifier false

Must Support true

24. Patient.extension:birthTime

Slice Name birthTime

Definition

The time of day that the Patient/Person/RelatedPerson/Practitioner was born. This includes the date to ensure that the timezone information can be communicated effectively.

Short Birth time

Comments

The patient prefix on the extension was retained to ensure backward compatibility with existing data (the content itself is provided to assist in sharing data across patient resources effectively)

Control 0..1

Type Extension(Patient/Person/RelatedPerson/Practitioner Birth Time) (Extension Type: dateTime)

Is Modifier false

Summary false

26. Patient.extension:sexAssignedAtBirth

Slice Name sexAssignedAtBirth

Definition

A sex or gender property for the individual from a document or other record

Short A recorded sex or gender property for the individual

Comments

HIQA PS 1.4.4 Sex (Mandatory 1..1): sex assigned at birth, e.g. male or female.

Control 1..1

Type Extension(Person Recorded Sex Or Gender) (Complex Extension)

Is Modifier false

Must Support true

28. Patient.extension:sexAssignedAtBirth.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 20..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

30. Patient.extension:sexAssignedAtBirth.extension:value

Slice Name value

Definition

A sex or gender property for the individual from a document or other record

Short The recorded sex or gender property for the individualAdditional content defined by implementations

Control 10..1*

Is Modifier false

Summary false

32. Patient.extension:sexAssignedAtBirth.extension:value.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

34. Patient.extension:sexAssignedAtBirth.extension:value.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value value

36. Patient.extension:sexAssignedAtBirth.extension:value.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Binding For example codes, see For codes, see AdministrativeGender
(example to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

Type CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

38. Patient.extension:sexAssignedAtBirth.extension:type

Slice Name type

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Control 10..1*

Is Modifier false

Summary false

40. Patient.extension:sexAssignedAtBirth.extension:type.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

42. Patient.extension:sexAssignedAtBirth.extension:type.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value type

44. Patient.extension:sexAssignedAtBirth.extension:type.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Binding For example codes, see For codes, see RecordedSexOrGenderType (2.0.0)
(example to http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type|2.0.0)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Pattern Value { "coding" : [{ "system" : "http://loinc.org", "code" : "76689-9", "display" : "Sex assigned at birth" }] }

46. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod

Slice Name effectivePeriod

Definition

The time period during which the recorded sex or gender value applies to the individual

Short When the recorded sex or gender value appliesAdditional content defined by implementations

Control 0..1*

Is Modifier false

Summary false

48. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

50. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value effectivePeriod

52. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate

Slice Name acquisitionDate

Definition

The date/time when the sex or gender value was first recorded in the system.

Short When the sex or gender value was recorded.Additional content defined by implementations

Control 0..1*

Is Modifier false

Summary false

54. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

56. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value acquisitionDate

58. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Type dateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

60. Patient.extension:sexAssignedAtBirth.extension:source

Slice Name source

Definition

A reference to the source of the Recorded Sex or Gender value.

Short The source of the Recorded Sex or Gender value.Additional content defined by implementations

Comments

Unlike the sourceDocument element, this element can reference non-document sources including applications, organisations or individuals. For example, if the Recored Sex or Gender value is recorded in a national patient identifier system this element may reference that system. This element can also be the source of the document referred to in the sourceDocument element. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.

Control 0..1*

Is Modifier false

Summary false

62. Patient.extension:sexAssignedAtBirth.extension:source.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

64. Patient.extension:sexAssignedAtBirth.extension:source.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value source

66. Patient.extension:sexAssignedAtBirth.extension:source.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Type Choice of: CodeableConcept, Reference(Organization, Device, RelatedPerson, Practitioner), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

68. Patient.extension:sexAssignedAtBirth.extension:sourceDocument

Slice Name sourceDocument

Definition

The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.

Short The document the sex or gender property was acquired from.Additional content defined by implementations

Comments

For example, if a driver's license is scanned, this property may reference that scanned document. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.

Control 0..1*

Is Modifier false

Summary false

70. Patient.extension:sexAssignedAtBirth.extension:sourceDocument.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

72. Patient.extension:sexAssignedAtBirth.extension:sourceDocument.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value sourceDocument

74. Patient.extension:sexAssignedAtBirth.extension:sourceDocument.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Type Choice of: CodeableConcept, Reference(DocumentReference), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

76. Patient.extension:sexAssignedAtBirth.extension:sourceField

Slice Name sourceField

Definition

The name of the field within the source document where this sex or gender property is initially recorded.

Short The name of the field within the source document where this sex or gender property is initially recorded.Additional content defined by implementations

Comments

For example, if a sex value is acquired from a driver's license, and the name of the field on that driver's license is 'SEX', then a code describing that field can be provided. If the semantics of the field are known, they may be described in the comment. For example, if the 'SEX' field on a license in a particular state or province is populated based on an individual's indication of what gender they consider themselves to be, but the field label is 'SEX' for historical reasons, a comment describing that the semantics of the field align with gender identity, even though the field name is 'SEX' can be provided.

Control 0..1*

Is Modifier false

Summary false

78. Patient.extension:sexAssignedAtBirth.extension:sourceField.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

80. Patient.extension:sexAssignedAtBirth.extension:sourceField.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value sourceField

82. Patient.extension:sexAssignedAtBirth.extension:sourceField.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Type string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

84. Patient.extension:sexAssignedAtBirth.extension:jurisdiction

Slice Name jurisdiction

Definition

Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired.

Short Who issued the document where the sex or gender was aquiredAdditional content defined by implementations

Comments

For example, a individual's driver's license or passport would be issued by a specific state or country.

Control 0..1*

Is Modifier false

Summary false

86. Patient.extension:sexAssignedAtBirth.extension:jurisdiction.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

88. Patient.extension:sexAssignedAtBirth.extension:jurisdiction.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value jurisdiction

90. Patient.extension:sexAssignedAtBirth.extension:jurisdiction.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Binding Unless not suitable, these codes SHALL be taken from For codes, see JurisdictionValueSet (1.0.0)
(extensible to http://terminology.hl7.org/ValueSet/jurisdiction|1.0.0)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

92. Patient.extension:sexAssignedAtBirth.extension:comment

Slice Name comment

Definition

Further explanation about the context or source of the recorded sex or gender value

Short Context or source information about the recorded sex or genderAdditional content defined by implementations

Control 0..1*

Is Modifier false

Summary false

94. Patient.extension:sexAssignedAtBirth.extension:comment.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

96. Patient.extension:sexAssignedAtBirth.extension:comment.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value comment

98. Patient.extension:sexAssignedAtBirth.extension:comment.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

100. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier

Slice Name genderElementQualifier

Definition

Instances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource. For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context.

Short Whether this recorded sex or gender value qualifies the .gender element.Additional content defined by implementations

Control 0..1*

Is Modifier false

Summary false

102. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

104. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value genderElementQualifier

106. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1

Type boolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

108. Patient.extension:sexAssignedAtBirth.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

110. Patient.extension:sexAssignedAtBirth.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 0..01

Type Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

112. Patient.extension:ethnicity

Slice Name ethnicity

Definition

A patient's ethnicity (repeat the extension for more than one ethnic background). GDPR Art. 9 special-category data. HIQA PS 1.4.10 (Required 0..*, coded). It is NOT part of the HIQA ePrescription/eDispensation dataset and is prohibited in the IE Medication Events ePrescription patient (ADR-002, ADR-009). HIQA: 'not used for patient identification'; collected with appropriate safeguards and consent.

Short IE Core Ethnicity

Comments

HIQA PS 1.4.10 Ethnicity (Required 0..*, coded). GDPR Art. 9 special-category data: send only when recorded with appropriate safeguards and consent. HIQA says it is not used for patient identification.

Control 0..*

Type Extension(IE Core Ethnicity) (Extension Type: CodeableConcept)

Is Modifier false

Must Support true

Summary false

114. Patient.extension:mothersFormerSurname

Slice Name mothersFormerSurname

Definition

One former surname of the patient's mother (repeat for each). HIQA PS 1.4.6 'Mother's former surnames' (Required 0..*): all former surnames of the patient's mother that may help identify the patient. The HL7 patient-mothersMaidenName extension holds only one name. Whether HIQA means the mother's birth surname only is Requires Clarification (OI-011). Patient Summary only; prohibited in ePrescription (ADR-002).

Short IE Core Mother's Former Surname

Comments

HIQA PS 1.4.6 Mother's former surnames (Required 0..*). OI-011.

Control 0..*

Type Extension(IE Core Mother's Former Surname) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

116. Patient.extension:countryOfAffiliation

Slice Name countryOfAffiliation

Definition

HIQA PS 1.4.8 Country of affiliation (Required 0..1): the designated source country where the patient and their health information are based. Typically, but not always, the country of residence, and it may differ from nationality. No HL7 extension exists. Patient Summary only; prohibited in ePrescription (ADR-002).

Short IE Core Country of Affiliation

Comments

HIQA PS 1.4.8 Country of affiliation (Required 0..1).

Control 0..1

Type Extension(IE Core Country of Affiliation) (Extension Type: CodeableConcept)

Is Modifier false

Must Support true

Summary false

118. Patient.extension:religion

Slice Name religion

Definition

The patient's professed religious affiliations.

Short The patient's professed religious affiliations

Comments

Prohibited: not in the HIQA PS dataset; GDPR Art. 9 special-category data.

Control 0..0

Type Extension(Patient Religion) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

120. Patient.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content

122. Patient.identifier

Definition

An identifier for this patient.

Short Patient identifiersAn identifier for this patient

Comments

HIQA PS 1.3.1 IHI (slice imposed by IECorePatient), 1.3.2 PPSN, 1.3.3 other identifiers (type, value, period, issuing organisation; all Required).

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ system

124. Patient.identifier.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

126. Patient.identifier.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

128. Patient.identifier.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

130. Patient.identifier.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Must Support true

Summary true

132. Patient.identifier.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Must Support true

Summary true

134. Patient.identifier:PPSN

Slice Name PPSN

Definition

An identifier for this patient.

Short Personal Public Service Number (PPSN): Requires ClarificationAn identifier for this patient

Comments

HIQA PS 1.3.2 (Required 0..1). Deliberately NOT MustSupport: the legal basis for using the PPSN as a health identifier is Requires Clarification (OI-008). The IHI (PS 1.3.1) slice is imposed by IECorePatient.

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1*

Is Modifier false

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ie-pat-ppsn-1: PPSN format: seven numbers followed by one or two letters (HIQA EP/PS 1.3.2) (value.matches('^[0-9]{7}[A-Za-z]{1,2}$'))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

136. Patient.identifier:PPSN.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

138. Patient.identifier:PPSN.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

140. Patient.identifier:PPSN.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 10..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps

Example General: http://www.acme.com/identifiers/patient

142. Patient.identifier:PPSN.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

Control 10..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

144. Patient.identifier:PPSN.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Must Support true

Summary true

146. Patient.identifier:PPSN.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Must Support true

Summary true

148. Patient.active

Definition

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

It is often used to filter patient lists to exclude inactive patients

Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

Short Whether this patient's record is in active use

Comments

If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

Control 0..1

Is Modifier true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be able to mark a patient record as not to be used because it was created in error.

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

150. Patient.name

Definition

A name associated with the individual.

Short A name associated with the patient

Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

Control 10..*

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate

SHALL:handle

SHOULD:display

Summary true

Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present (family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists())
ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present (family.exists() or given.exists() or text.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

152. Patient.name.use

Definition

Identifies the purpose for this name.

Comments

HIQA PS 1.1.6 Former names (Required 0..*) use 'old'; 1.1.7 Preferred name (Required 0..1) uses 'usual'.

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

154. Patient.name.family

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Short Family name.Family name (often called 'Surname')

Comments

HIQA PS 1.1.4 Surname (Mandatory 1..1).

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control 10..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Alternate Names surname

Example spanish: Valero Iglesias

156. Patient.name.given

Definition

Given name.

Short Given names (not always 'first'). Includes middle names

Comments

HIQA PS 1.1.2 Forename (Mandatory 1..1); PS 1.1.3 Middle name(s) (Required 0..1) as further given names.

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control 10..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Alternate Names first name, middle name

158. Patient.name.prefix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Short Parts that come before the name

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

160. Patient.name.suffix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Short Parts that come after the name

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

162. Patient.telecom

Definition

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Short A contact detail for the patientA contact detail for the individual

Comments

HIQA PS 1.5.1 Mobile phone, 1.5.2 Email (Required); 1.5.3 Other communication details (Optional); 1.5.4 Preferred communication method (Required), expressed by rank = 1.

A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

Control 0..*

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

People have (primary) ways to contact them in some way such as phone, email.

164. Patient.telecom.system

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Short phone | fax | email | pager | url | sms | other

Control 0..1
This element is affected by the following invariants: cpt-2

The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
(required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

Telecommunications form for contact point.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

166. Patient.telecom.value

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Short The actual contact point details

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

168. Patient.telecom.use

Definition

Identifies the purpose for the contact point.

Short home | work | temp | old | mobile - purpose of this contact point

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

Use of contact point.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

170. Patient.telecom.rank

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Short Specify preferred order of use (1 = highest)

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

172. Patient.gender

Definition

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Short Administrative Gendermale | female | other | unknown

Comments

The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

Control 10..1

The codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Needed for identification of the individual, in combination with (at least) name and birth date.

174. Patient.birthDate

Definition

The date of birth for the individual.

Short The date of birth for the individual

Comments

HIQA PS 1.4.1 Date of birth (Mandatory 1..1). HIQA: if unknown, record 1900-01-01 (estimated age, PS 1.4.2, is Optional and not modelled).

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

Control 10..1

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Age of the individual drives many clinical processes.

LOINC Code 21112-8

176. Patient.deceased[x]

Definition

Indicates if the individual is deceased or not.

Short Indicates if the individual is deceased or not

Comments

HIQA PS 1.4.11 Date of death (Required 0..1) as deceasedDateTime. PS 1.4.12 Cause of death (Required) has no Patient element: Requires Clarification.

If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

Control 0..1

Type Choice of: boolean, dateTime

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Must Support Types No must-support rules about the choice of types/profiles

Summary true

Requirements

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

178. Patient.address

Definition

An address for the individual.

Short An address for the individual

Comments

Patient may have multiple addresses with different uses or applicable periods.

Control 10..*

Type Address(Address (EU))

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

180. Patient.address.use

Definition

The purpose of this address.

Short Purpose of this addresshome | work | temp | old | billing - purpose of this address

Comments

HIQA PS 1.2.6 Address type (Mandatory 1..1).

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control 10..1

The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General: home

182. Patient.address.line

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Short Street name, number, direction & P.O. Box etc.

Comments

HIQA PS 1.2.2 Address line(s) (Mandatory 1..1).

Control 10..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 137 Nowhere Street

184. Patient.address.line.extension:streetName

Slice Name streetName

Definition

streetName.

Short streetName

Control 0..*

Type Extension(ADXP Street Name) (Extension Type: string)

Is Modifier false

Summary false

186. Patient.address.line.extension:houseNumber

Slice Name houseNumber

Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Short houseNumber

Control 0..*

Type Extension(ADXP House Number) (Extension Type: string)

Is Modifier false

Summary false

188. Patient.address.line.extension:postBox

Slice Name postBox

Definition

A numbered box located in a post station.

Short postBox

Control 0..*

Type Extension(ADXP Post Box) (Extension Type: string)

Is Modifier false

Summary false

190. Patient.address.city

Definition

The name of the city, town, suburb, village or other community or delivery center.

Short CityName of city, town etc.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Municpality

Example General: Erewhon

192. Patient.address.state

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Short Sub-unit of country (abbreviations ok)

Comments

HIQA PS 1.2.4 District/County (Mandatory 1..1).

Control 10..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Province, Territory

194. Patient.address.postalCode

Definition

A postal code designating a region defined by the postal service.

Short Postal codePostal code for area

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Zip

Example General: 9132

196. Patient.address.country

Definition

Country - a nation as commonly understood or generally accepted.

Short Country (e.g. can be ISO 3166 2 or 3 letter code)

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

198. Patient.address.country.extension:countryCode

Slice Name countryCode

Definition

Provides a coded expression for the content represented in a string.

Short code for string

Control 0..1

Type Extension(Coded string) (Extension Type: Coding)

Is Modifier false

Summary false

200. Patient.address.country.extension:countryCode.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

202. Patient.address.country.extension:countryCode.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-codedString

204. Patient.address.country.extension:countryCode.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1
This element is affected by the following invariants: ext-1

Binding The codes SHOULD be taken from For codes, see Iso3166-1-2
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

Type Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

206. Patient.maritalStatus

Definition

This field contains a patient's most recent marital (civil) status.

Short Marital statusMarital (civil) status of a patient

Comments

Prohibited: not in the HIQA PS dataset.

Control 0..01

Unless not suitable, these codes SHALL be taken from Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/marital-status|4.0.1)

The domestic partnership status of a person.

Is Modifier false

Summary false

Requirements

Most, if not all systems capture it.

208. Patient.contact

Definition

A contact party (e.g. guardian, partner, friend) for the patient.

Short Nominated contact person (HIQA PS Section 3)A contact party (e.g. guardian, partner, friend) for the patient

Comments

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

Control 0..*

Is Modifier false

Must Support true

Summary false

Requirements

Need to track people you can contact about the patient.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())

210. Patient.contact.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

212. Patient.contact.relationship

Definition

The nature of the relationship between the patient and the contact person.

Short Contact relationshipThe kind of relationship

Comments

HIQA PS 3.3 Role (Required 0..*) and 3.4 Relationship (Required 0..1).

Control 0..*

Unless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)

The nature of the relationship between a patient and a contact person for that patient.

Is Modifier false

Must Support true

Summary false

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

214. Patient.contact.name

Definition

A name associated with the contact person.

Short Contact nameA name associated with the contact person

Control 0..1

Is Modifier false

Must Support true

Summary false

Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

216. Patient.contact.name.use

Definition

Identifies the purpose for this name.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

218. Patient.contact.name.family

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Short Family name (often called 'Surname')

Comments

HIQA PS 3.2 Surname of nominated contact person (Required 0..1).

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names surname

220. Patient.contact.name.given

Definition

Given name.

Short Given names (not always 'first'). Includes middle names

Comments

HIQA PS 3.1 Forename of nominated contact person (Required 0..1).

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names first name, middle name

222. Patient.contact.telecom

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Short Contact details for the personA contact detail for the person

Comments

HIQA PS 3.5 Communication details (Required): 3.5.1 mobile, 3.5.2 landline, 3.5.3 email.

Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Control 0..*

Is Modifier false

Must Support true

Summary false

Requirements

People have (primary) ways to contact them in some way such as phone, email.

224. Patient.contact.telecom.use

Definition

Identifies the purpose for the contact point.

Short home | work | temp | old | mobile - purpose of this contact point

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

Use of contact point.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

226. Patient.contact.telecom.rank

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Short Specify preferred order of use (1 = highest)

Comments

HIQA PS 3.7 Preferred communication type for the nominated contact person (Required): rank = 1.

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

228. Patient.contact.address

Definition

Address for the contact person.

Short Contact person addressAddress for the contact person

Comments

HIQA PS 3.6 Address of nominated contact person (Optional 0..1).

Control 0..1

Type Address(Address (EU))

Is Modifier false

Summary false

Requirements

Need to keep track where the contact person can be contacted per postal mail or visited.

230. Patient.contact.address.use

Definition

The purpose of this address.

Short Purpose of this addresshome | work | temp | old | billing - purpose of this address

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General: home

232. Patient.contact.address.line

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Short Street name, number, direction & P.O. Box etc.

Comments

HIQA PS 3.6.2 Address line(s): Mandatory when the contact address is given.

Control 10..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 137 Nowhere Street

234. Patient.contact.address.line.extension:streetName

Slice Name streetName

Definition

streetName.

Short streetName

Control 0..*

Type Extension(ADXP Street Name) (Extension Type: string)

Is Modifier false

Summary false

236. Patient.contact.address.line.extension:houseNumber

Slice Name houseNumber

Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Short houseNumber

Control 0..*

Type Extension(ADXP House Number) (Extension Type: string)

Is Modifier false

Summary false

238. Patient.contact.address.line.extension:postBox

Slice Name postBox

Definition

A numbered box located in a post station.

Short postBox

Control 0..*

Type Extension(ADXP Post Box) (Extension Type: string)

Is Modifier false

Summary false

240. Patient.contact.address.city

Definition

The name of the city, town, suburb, village or other community or delivery center.

Short CityName of city, town etc.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Municpality

Example General: Erewhon

242. Patient.contact.address.state

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Short Sub-unit of country (abbreviations ok)

Comments

HIQA PS 3.6.4 District/County/City: Mandatory when the contact address is given.

Control 10..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Province, Territory

244. Patient.contact.address.postalCode

Definition

A postal code designating a region defined by the postal service.

Short Postal codePostal code for area

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Zip

Example General: 9132

246. Patient.contact.address.country

Definition

Country - a nation as commonly understood or generally accepted.

Short Country (e.g. can be ISO 3166 2 or 3 letter code)

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

248. Patient.contact.address.country.extension:countryCode

Slice Name countryCode

Definition

Provides a coded expression for the content represented in a string.

Short code for string

Control 0..1

Type Extension(Coded string) (Extension Type: Coding)

Is Modifier false

Summary false

250. Patient.contact.address.country.extension:countryCode.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.contact.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

252. Patient.contact.address.country.extension:countryCode.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-codedString

254. Patient.contact.address.country.extension:countryCode.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 10..1
This element is affected by the following invariants: ext-1

Binding The codes SHOULD be taken from For codes, see Iso3166-1-2
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

256. Patient.communication

Definition

A language which may be used to communicate with the patient about his or her health.

Short A language which may be used to communicate with the patient about his or her health

Comments

HIQA PS 1.4.9 Preferred language (Optional 0..*), including sign language.

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Control 0..*

Is Modifier false

Must Support true

Summary false

Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

258. Patient.communication.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

260. Patient.communication.language

Definition

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

Short Communication languageThe language which can be used to communicate with the patient about his or her health

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Control 1..1

AllLanguages
AllLanguages

The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Max Binding

Is Modifier false

Must Support true

Summary false

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

262. Patient.generalPractitioner

Definition

Patient's nominated care provider.

Short Patient's nominated primary care provider.

Comments

HIQA PS Section 2: General Practitioner details must be captured in all cases.

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

Control 0..*

Type Reference(Organization (EU core), PractitionerRole (EU core), Practitioner (EU core), Organization, Practitioner, PractitionerRole)

Is Modifier false

Must Support true

Must Support Types No must-support rules about the choice of types/profiles

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary false

Alternate Names careProvider

264. Patient.link

Definition

Link to another patient resource that concerns the same actual patient.

Short Link to another patient resource that concerns the same actual person

Comments

There is no assumption that linked patient records have mutual links.

Control 0..*

Is Modifier true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'

Summary true

Requirements

There are multiple use cases:

Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
Distribution of patient information across multiple servers.

266. Patient.link.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

268. Patient.link.other

Definition

The other patient resource that the link refers to.

Short The other patient or related person resource that the link refers to

Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Control 1..1

Type Reference(Patient, RelatedPerson)

Is Modifier false

Summary true

270. Patient.link.type

Definition

The type of link between this patient resource and another patient resource.

Short replaced-by | replaces | refer | seealso

Control 1..1

The codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

The type of link between this patient resource and another patient resource.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Guidance on how to interpret the contents of this table can be foundhere

0. Patient
Impose Profile	This profile also requires that the instance also conform this additional profile: IE Core Patient
2. Patient.extension
Control	1..?
4. Patient.extension:birthPlace
Slice Name	birthPlace
Comments	HIQA PS 1.4.3 Place of birth (Required 0..1): the county (in Ireland) or city (elsewhere) of birth, carried in valueAddress.state or valueAddress.city.
Must Support	true
6. Patient.extension:gender-identity
Slice Name	gender-identity
Comments	HIQA PS 1.4.5 Gender cluster (Required 0..1): 1.4.5.1 Gender (coded) and 1.4.5.2 Other gender identity (valueCodeableConcept.text).
Control	0..1
Must Support	true
8. Patient.extension:pronouns
Slice Name	pronouns
Comments	Prohibited: not in the HIQA PS dataset.
Control	0..0
10. Patient.extension:patient-nationality
Slice Name	patient-nationality
Comments	HIQA PS 1.4.7 Nationality (Required 0..*, coded): country of legal citizenship.
Must Support	true
12. Patient.extension:sexAssignedAtBirth
Slice Name	sexAssignedAtBirth
Comments	HIQA PS 1.4.4 Sex (Mandatory 1..1): sex assigned at birth, e.g. male or female.
Control	1..1
Type	Extension(Person Recorded Sex Or Gender) (Complex Extension)
Must Support	true
14. Patient.extension:sexAssignedAtBirth.extension
Control	2..?
16. Patient.extension:sexAssignedAtBirth.extension:type
Slice Name	type
Control	1..?
18. Patient.extension:sexAssignedAtBirth.extension:type.value[x]
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Pattern Value	`{ "coding" : [{ "system" : "http://loinc.org", "code" : "76689-9", "display" : "Sex assigned at birth" }] }`
20. Patient.extension:ethnicity
Slice Name	ethnicity
Comments	HIQA PS 1.4.10 Ethnicity (Required 0..*, coded). GDPR Art. 9 special-category data: send only when recorded with appropriate safeguards and consent. HIQA says it is not used for patient identification.
Control	0..*
Type	Extension(IE Core Ethnicity) (Extension Type: CodeableConcept)
Must Support	true
22. Patient.extension:mothersFormerSurname
Slice Name	mothersFormerSurname
Comments	HIQA PS 1.4.6 Mother's former surnames (Required 0..*). OI-011.
Control	0..*
Type	Extension(IE Core Mother's Former Surname) (Extension Type: string)
Must Support	true
24. Patient.extension:countryOfAffiliation
Slice Name	countryOfAffiliation
Comments	HIQA PS 1.4.8 Country of affiliation (Required 0..1).
Control	0..1
Type	Extension(IE Core Country of Affiliation) (Extension Type: CodeableConcept)
Must Support	true
26. Patient.extension:religion
Slice Name	religion
Comments	Prohibited: not in the HIQA PS dataset; GDPR Art. 9 special-category data.
Control	0..0
Type	Extension(Patient Religion) (Extension Type: CodeableConcept)
28. Patient.identifier
Comments	HIQA PS 1.3.1 IHI (slice imposed by IECorePatient), 1.3.2 PPSN, 1.3.3 other identifiers (type, value, period, issuing organisation; all Required).
Note	This is a business identifier, not a resource identifier (see discussion)
Must Support	true
Slicing	This element introduces a set of slices on `Patient.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
30. Patient.identifier.type
Must Support	true
32. Patient.identifier.value
Must Support	true
34. Patient.identifier.period
Must Support	true
36. Patient.identifier.assigner
Must Support	true
38. Patient.identifier:PPSN
Slice Name	PPSN
Short	Personal Public Service Number (PPSN): Requires Clarification
Comments	HIQA PS 1.3.2 (Required 0..1). Deliberately NOT MustSupport: the legal basis for using the PPSN as a health identifier is Requires Clarification (OI-008). The IHI (PS 1.3.1) slice is imposed by IECorePatient.
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..1
Invariants	ie-pat-ppsn-1: PPSN format: seven numbers followed by one or two letters (HIQA EP/PS 1.3.2) (`value.matches('^[0-9]{7}[A-Za-z]{1,2}$')`)
40. Patient.identifier:PPSN.system
Control	1..?
Pattern Value	`https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps`
42. Patient.identifier:PPSN.value
Control	1..?
44. Patient.name
Must Support	true
46. Patient.name.use
Comments	HIQA PS 1.1.6 Former names (Required 0..*) use 'old'; 1.1.7 Preferred name (Required 0..1) uses 'usual'.
Must Support	true
48. Patient.name.family
Comments	HIQA PS 1.1.4 Surname (Mandatory 1..1).
Control	1..?
Must Support	true
50. Patient.name.given
Comments	HIQA PS 1.1.2 Forename (Mandatory 1..1); PS 1.1.3 Middle name(s) (Required 0..1) as further given names.
Control	1..?
Must Support	true
52. Patient.name.prefix
Must Support	true
54. Patient.name.suffix
Must Support	true
56. Patient.telecom
Comments	HIQA PS 1.5.1 Mobile phone, 1.5.2 Email (Required); 1.5.3 Other communication details (Optional); 1.5.4 Preferred communication method (Required), expressed by rank = 1.
Must Support	true
58. Patient.telecom.system
Must Support	true
60. Patient.telecom.value
Must Support	true
62. Patient.telecom.use
Must Support	true
64. Patient.telecom.rank
Must Support	true
66. Patient.gender
Control	1..?
Must Support	true
68. Patient.birthDate
Comments	HIQA PS 1.4.1 Date of birth (Mandatory 1..1). HIQA: if unknown, record 1900-01-01 (estimated age, PS 1.4.2, is Optional and not modelled).
Must Support	true
LOINC Code
70. Patient.deceased[x]
Comments	HIQA PS 1.4.11 Date of death (Required 0..1) as deceasedDateTime. PS 1.4.12 Cause of death (Required) has no Patient element: Requires Clarification.
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Must Support	true
72. Patient.address
Control	1..?
Must Support	true
74. Patient.address.use
Comments	HIQA PS 1.2.6 Address type (Mandatory 1..1).
Control	1..?
Must Support	true
76. Patient.address.line
Comments	HIQA PS 1.2.2 Address line(s) (Mandatory 1..1).
Control	1..?
Must Support	true
78. Patient.address.city
Must Support	true
80. Patient.address.state
Comments	HIQA PS 1.2.4 District/County (Mandatory 1..1).
Control	1..?
Must Support	true
82. Patient.address.postalCode
Must Support	true
84. Patient.address.country
Must Support	true
86. Patient.maritalStatus
Comments	Prohibited: not in the HIQA PS dataset.
Control	0..0
88. Patient.contact
Short	Nominated contact person (HIQA PS Section 3)
Must Support	true
90. Patient.contact.relationship
Comments	HIQA PS 3.3 Role (Required 0..*) and 3.4 Relationship (Required 0..1).
Must Support	true
92. Patient.contact.name
Must Support	true
94. Patient.contact.name.family
Comments	HIQA PS 3.2 Surname of nominated contact person (Required 0..1).
Must Support	true
96. Patient.contact.name.given
Comments	HIQA PS 3.1 Forename of nominated contact person (Required 0..1).
Must Support	true
98. Patient.contact.telecom
Comments	HIQA PS 3.5 Communication details (Required): 3.5.1 mobile, 3.5.2 landline, 3.5.3 email.
Must Support	true
100. Patient.contact.telecom.rank
Comments	HIQA PS 3.7 Preferred communication type for the nominated contact person (Required): rank = 1.
Must Support	true
102. Patient.contact.address
Comments	HIQA PS 3.6 Address of nominated contact person (Optional 0..1).
104. Patient.contact.address.line
Comments	HIQA PS 3.6.2 Address line(s): Mandatory when the contact address is given.
Control	1..?
106. Patient.contact.address.city
Must Support	true
108. Patient.contact.address.state
Comments	HIQA PS 3.6.4 District/County/City: Mandatory when the contact address is given.
Control	1..?
110. Patient.contact.address.postalCode
Must Support	true
112. Patient.contact.address.country
Must Support	true
114. Patient.communication
Comments	HIQA PS 1.4.9 Preferred language (Optional 0..*), including sign language.
Must Support	true
116. Patient.communication.language
Must Support	true
118. Patient.generalPractitioner
Comments	HIQA PS Section 2: General Practitioner details must be captured in all cases.
Must Support	true

Guidance on how to interpret the contents of this table can be foundhere

0. Patient

Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Short Information about an individual or animal receiving health care services

Control 0..*

Is Modifier false

Impose Profile

This profile also requires that the instance also conform this additional profile:

IE Core Patient

Summary false

Alternate Names SubjectOfCare Client Resident

2. Patient.id

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short Logical id of this artifact

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control 0..1

Is Modifier false

Summary true

4. Patient.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Patient.implicitRules

Definition

Short A set of rules under which this content was created

Comments

Control 0..1

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Patient.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control 0..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Patient.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Patient.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline Resources

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. Patient.extension

Definition

An Extension

Short Extension

Control 1..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Patient.extension:birthPlace

Slice Name birthPlace

Definition

The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

Short Place of Birth for patient

Comments

HIQA PS 1.4.3 Place of birth (Required 0..1): the county (in Ireland) or city (elsewhere) of birth, carried in valueAddress.state or valueAddress.city.

Control 0..1

Type Extension(Patient Birth Place) (Extension Type: Address)

Is Modifier false

Must Support true

Summary false

18. Patient.extension:birthPlace.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

20. Patient.extension:birthPlace.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

22. Patient.extension:birthPlace.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/patient-birthPlace

24. Patient.extension:birthPlace.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1
This element is affected by the following invariants: ext-1

Type Address(Address (EU))

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

26. Patient.extension:sex-for-clinical-use

Slice Name sex-for-clinical-use

Definition

Short Sex for clinical use

Control 0..*

Type Extension(Patient Sex Parameter For Clinical Use) (Complex Extension)

Is Modifier false

28. Patient.extension:gender-identity

Slice Name gender-identity

Definition

An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.

Short The individual's gender identity

Comments

HIQA PS 1.4.5 Gender cluster (Required 0..1): 1.4.5.1 Gender (coded) and 1.4.5.2 Other gender identity (valueCodeableConcept.text).

Control 0..1

Type Extension(Individual Gender Identity) (Complex Extension)

Is Modifier false

Must Support true

30. Patient.extension:pronouns

Slice Name pronouns

Definition

The pronouns to use when referring to an individual in verbal or written communication.

Short The pronouns to use when communicating about an individual.

Comments

Prohibited: not in the HIQA PS dataset.

Control 0..0

Type Extension(Individual Pronouns) (Complex Extension)

Is Modifier false

32. Patient.extension:patient-citizenship

Slice Name patient-citizenship

Definition

The patient's legal status as citizen of a country.

Short Citizenship

Control 0..*

Type Extension(Patient Citizenship) (Complex Extension)

Is Modifier false

34. Patient.extension:patient-nationality

Slice Name patient-nationality

Definition

The nationality of the patient.

Short Nationality

Comments

HIQA PS 1.4.7 Nationality (Required 0..*, coded): country of legal citizenship.

Control 0..*

Type Extension(Patient Nationality) (Complex Extension)

Is Modifier false

Must Support true

36. Patient.extension:birthTime

Slice Name birthTime

Definition

The time of day that the Patient/Person/RelatedPerson/Practitioner was born. This includes the date to ensure that the timezone information can be communicated effectively.

Short Birth time

Comments

The patient prefix on the extension was retained to ensure backward compatibility with existing data (the content itself is provided to assist in sharing data across patient resources effectively)

Control 0..1

Type Extension(Patient/Person/RelatedPerson/Practitioner Birth Time) (Extension Type: dateTime)

Is Modifier false

Summary false

38. Patient.extension:sexAssignedAtBirth

Slice Name sexAssignedAtBirth

Definition

A sex or gender property for the individual from a document or other record

Short A recorded sex or gender property for the individual

Comments

HIQA PS 1.4.4 Sex (Mandatory 1..1): sex assigned at birth, e.g. male or female.

Control 1..1

Type Extension(Person Recorded Sex Or Gender) (Complex Extension)

Is Modifier false

Must Support true

40. Patient.extension:sexAssignedAtBirth.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

42. Patient.extension:sexAssignedAtBirth.extension

Definition

An Extension

Short Extension

Control 2..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

44. Patient.extension:sexAssignedAtBirth.extension:value

Slice Name value

Definition

A sex or gender property for the individual from a document or other record

Short The recorded sex or gender property for the individual

Control 1..1

Is Modifier false

Summary false

46. Patient.extension:sexAssignedAtBirth.extension:value.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

48. Patient.extension:sexAssignedAtBirth.extension:value.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

50. Patient.extension:sexAssignedAtBirth.extension:value.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value value

52. Patient.extension:sexAssignedAtBirth.extension:value.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

Binding For example codes, see AdministrativeGender
(example to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. Patient.extension:sexAssignedAtBirth.extension:type

Slice Name type

Definition

An Extension

Short Extension

Control 1..1

Is Modifier false

Summary false

56. Patient.extension:sexAssignedAtBirth.extension:type.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

58. Patient.extension:sexAssignedAtBirth.extension:type.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

60. Patient.extension:sexAssignedAtBirth.extension:type.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value type

62. Patient.extension:sexAssignedAtBirth.extension:type.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

Binding For example codes, see RecordedSexOrGenderType (2.0.0)
(example to http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type|2.0.0)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Pattern Value { "coding" : [{ "system" : "http://loinc.org", "code" : "76689-9", "display" : "Sex assigned at birth" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod

Slice Name effectivePeriod

Definition

The time period during which the recorded sex or gender value applies to the individual

Short When the recorded sex or gender value applies

Control 0..1

Is Modifier false

Summary false

66. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

68. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

70. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value effectivePeriod

72. Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 0..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

74. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate

Slice Name acquisitionDate

Definition

The date/time when the sex or gender value was first recorded in the system.

Short When the sex or gender value was recorded.

Control 0..1

Is Modifier false

Summary false

76. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

78. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

80. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value acquisitionDate

82. Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

dateTime

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. Patient.extension:sexAssignedAtBirth.extension:source

Slice Name source

Definition

A reference to the source of the Recorded Sex or Gender value.

Short The source of the Recorded Sex or Gender value.

Comments

Control 0..1

Is Modifier false

Summary false

86. Patient.extension:sexAssignedAtBirth.extension:source.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

88. Patient.extension:sexAssignedAtBirth.extension:source.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

90. Patient.extension:sexAssignedAtBirth.extension:source.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value source

92. Patient.extension:sexAssignedAtBirth.extension:source.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

Type Choice of: CodeableConcept, Reference(Organization, Device, RelatedPerson, Practitioner)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

94. Patient.extension:sexAssignedAtBirth.extension:sourceDocument

Slice Name sourceDocument

Definition

The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.

Short The document the sex or gender property was acquired from.

Comments

Control 0..1

Is Modifier false

Summary false

96. Patient.extension:sexAssignedAtBirth.extension:sourceDocument.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

98. Patient.extension:sexAssignedAtBirth.extension:sourceDocument.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

100. Patient.extension:sexAssignedAtBirth.extension:sourceDocument.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value sourceDocument

102. Patient.extension:sexAssignedAtBirth.extension:sourceDocument.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

Type Choice of: CodeableConcept, Reference(DocumentReference)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

104. Patient.extension:sexAssignedAtBirth.extension:sourceField

Slice Name sourceField

Definition

The name of the field within the source document where this sex or gender property is initially recorded.

Short The name of the field within the source document where this sex or gender property is initially recorded.

Comments

Control 0..1

Is Modifier false

Summary false

106. Patient.extension:sexAssignedAtBirth.extension:sourceField.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

108. Patient.extension:sexAssignedAtBirth.extension:sourceField.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

110. Patient.extension:sexAssignedAtBirth.extension:sourceField.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value sourceField

112. Patient.extension:sexAssignedAtBirth.extension:sourceField.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

114. Patient.extension:sexAssignedAtBirth.extension:jurisdiction

Slice Name jurisdiction

Definition

Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired.

Short Who issued the document where the sex or gender was aquired

Comments

For example, a individual's driver's license or passport would be issued by a specific state or country.

Control 0..1

Is Modifier false

Summary false

116. Patient.extension:sexAssignedAtBirth.extension:jurisdiction.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

118. Patient.extension:sexAssignedAtBirth.extension:jurisdiction.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

120. Patient.extension:sexAssignedAtBirth.extension:jurisdiction.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value jurisdiction

122. Patient.extension:sexAssignedAtBirth.extension:jurisdiction.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

Binding Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (1.0.0)
(extensible to http://terminology.hl7.org/ValueSet/jurisdiction|1.0.0)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

124. Patient.extension:sexAssignedAtBirth.extension:comment

Slice Name comment

Definition

Further explanation about the context or source of the recorded sex or gender value

Short Context or source information about the recorded sex or gender

Control 0..1

Is Modifier false

Summary false

126. Patient.extension:sexAssignedAtBirth.extension:comment.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

128. Patient.extension:sexAssignedAtBirth.extension:comment.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

130. Patient.extension:sexAssignedAtBirth.extension:comment.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value comment

132. Patient.extension:sexAssignedAtBirth.extension:comment.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

134. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier

Slice Name genderElementQualifier

Definition

Short Whether this recorded sex or gender value qualifies the .gender element.

Control 0..1

Is Modifier false

Summary false

136. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

138. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

140. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value genderElementQualifier

142. Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

144. Patient.extension:sexAssignedAtBirth.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

146. Patient.extension:sexAssignedAtBirth.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

148. Patient.extension:ethnicity

Slice Name ethnicity

Definition

Short IE Core Ethnicity

Comments

Control 0..*

Type Extension(IE Core Ethnicity) (Extension Type: CodeableConcept)

Is Modifier false

Must Support true

Summary false

150. Patient.extension:mothersFormerSurname

Slice Name mothersFormerSurname

Definition

Short IE Core Mother's Former Surname

Comments

HIQA PS 1.4.6 Mother's former surnames (Required 0..*). OI-011.

Control 0..*

Type Extension(IE Core Mother's Former Surname) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

152. Patient.extension:countryOfAffiliation

Slice Name countryOfAffiliation

Definition

Short IE Core Country of Affiliation

Comments

HIQA PS 1.4.8 Country of affiliation (Required 0..1).

Control 0..1

Type Extension(IE Core Country of Affiliation) (Extension Type: CodeableConcept)

Is Modifier false

Must Support true

Summary false

154. Patient.extension:religion

Slice Name religion

Definition

The patient's professed religious affiliations.

Short The patient's professed religious affiliations

Comments

Prohibited: not in the HIQA PS dataset; GDPR Art. 9 special-category data.

Control 0..0

Type Extension(Patient Religion) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

156. Patient.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Requirements

Alternate Names extensions, user content

158. Patient.identifier

Definition

An identifier for this patient.

Short Patient identifiers

Comments

HIQA PS 1.3.1 IHI (slice imposed by IECorePatient), 1.3.2 PPSN, 1.3.3 other identifiers (type, value, period, issuing organisation; all Required).

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ system

160. Patient.identifier.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

162. Patient.identifier.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

164. Patient.identifier.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

166. Patient.identifier.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

168. Patient.identifier.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

170. Patient.identifier.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

172. Patient.identifier.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

174. Patient.identifier.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

176. Patient.identifier:PPSN

Slice Name PPSN

Definition

An identifier for this patient.

Short Personal Public Service Number (PPSN): Requires Clarification

Comments

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

178. Patient.identifier:PPSN.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

180. Patient.identifier:PPSN.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

182. Patient.identifier:PPSN.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

184. Patient.identifier:PPSN.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

186. Patient.identifier:PPSN.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

188. Patient.identifier:PPSN.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

190. Patient.identifier:PPSN.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

192. Patient.identifier:PPSN.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

194. Patient.active

Definition

It is often used to filter patient lists to exclude inactive patients

Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

Short Whether this patient's record is in active use

Comments

If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

Control 0..1

Is Modifier true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be able to mark a patient record as not to be used because it was created in error.

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

196. Patient.name

Definition

A name associated with the individual.

Short A name associated with the patient

Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

Control 1..*

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate

SHALL:handle

SHOULD:display

Summary true

Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided

198. Patient.name.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

200. Patient.name.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

202. Patient.name.use

Definition

Identifies the purpose for this name.

Comments

HIQA PS 1.1.6 Former names (Required 0..*) use 'old'; 1.1.7 Preferred name (Required 0..1) uses 'usual'.

Control 0..1

The codes SHALL be taken from NameUse
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

204. Patient.name.text

Definition

Text representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element.

Short Text representation of the full name.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

A renderable, unencoded form.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

206. Patient.name.family

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Short Family name.

Comments

HIQA PS 1.1.4 Surname (Mandatory 1..1).

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Alternate Names surname

Example spanish: Valero Iglesias

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

208. Patient.name.given

Definition

Given name.

Short Given names (not always 'first'). Includes middle names

Comments

HIQA PS 1.1.2 Forename (Mandatory 1..1); PS 1.1.3 Middle name(s) (Required 0..1) as further given names.

Control 1..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Alternate Names first name, middle name

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

210. Patient.name.prefix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Short Parts that come before the name

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

212. Patient.name.suffix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Short Parts that come after the name

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

214. Patient.name.period

Definition

Indicates the period of time when this name was valid for the named person.

Short Time period when name was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows names to be placed in historical context.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

216. Patient.telecom

Definition

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Short A contact detail for the patient

Comments

HIQA PS 1.5.1 Mobile phone, 1.5.2 Email (Required); 1.5.3 Other communication details (Optional); 1.5.4 Preferred communication method (Required), expressed by rank = 1.

Control 0..*

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

218. Patient.telecom.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

220. Patient.telecom.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

222. Patient.telecom.system

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Short phone | fax | email | pager | url | sms | other

Control 0..1
This element is affected by the following invariants: cpt-2

The codes SHALL be taken from ContactPointSystem
(required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

Telecommunications form for contact point.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

224. Patient.telecom.value

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Short The actual contact point details

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

226. Patient.telecom.use

Definition

Identifies the purpose for the contact point.

Short home | work | temp | old | mobile - purpose of this contact point

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from ContactPointUse
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

Use of contact point.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

228. Patient.telecom.rank

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Short Specify preferred order of use (1 = highest)

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

230. Patient.telecom.period

Definition

Time period when the contact point was/is in use.

Short Time period when the contact point was/is in use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

232. Patient.gender

Definition

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Short Administrative Gender

Comments

Control 1..1

The codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Needed for identification of the individual, in combination with (at least) name and birth date.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

234. Patient.birthDate

Definition

The date of birth for the individual.

Short The date of birth for the individual

Comments

HIQA PS 1.4.1 Date of birth (Mandatory 1..1). HIQA: if unknown, record 1900-01-01 (estimated age, PS 1.4.2, is Optional and not modelled).

Control 1..1

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

Age of the individual drives many clinical processes.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

LOINC Code 21112-8

236. Patient.deceased[x]

Definition

Indicates if the individual is deceased or not.

Short Indicates if the individual is deceased or not

Comments

HIQA PS 1.4.11 Date of death (Required 0..1) as deceasedDateTime. PS 1.4.12 Cause of death (Required) has no Patient element: Requires Clarification.

Control 0..1

Type Choice of: boolean, dateTime

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Must Support Types No must-support rules about the choice of types/profiles

Summary true

Requirements

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

238. Patient.address

Definition

An address for the individual.

Short An address for the individual

Comments

Patient may have multiple addresses with different uses or applicable periods.

Control 1..*

Type Address(Address (EU))

Is Modifier false

Must Support true

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary true

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

240. Patient.address.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

242. Patient.address.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

244. Patient.address.use

Definition

The purpose of this address.

Short Purpose of this address

Comments

HIQA PS 1.2.6 Address type (Mandatory 1..1).

Control 1..1

The codes SHALL be taken from AddressUse
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General: home

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

246. Patient.address.type

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Short Address type (postal | physical)

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control 0..1

The codes SHALL be taken from AddressType
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: both

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

248. Patient.address.text

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Short Text representation of the address

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Example General: 137 Nowhere Street, Erewhon 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

250. Patient.address.line

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Short Street name, number, direction & P.O. Box etc.

Comments

HIQA PS 1.2.2 Address line(s) (Mandatory 1..1).

Control 1..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 137 Nowhere Street

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

252. Patient.address.line.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

254. Patient.address.line.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

256. Patient.address.line.extension:streetName

Slice Name streetName

Definition

streetName.

Short streetName

Control 0..*

Type Extension(ADXP Street Name) (Extension Type: string)

Is Modifier false

Summary false

258. Patient.address.line.extension:houseNumber

Slice Name houseNumber

Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Short houseNumber

Control 0..*

Type Extension(ADXP House Number) (Extension Type: string)

Is Modifier false

Summary false

260. Patient.address.line.extension:postBox

Slice Name postBox

Definition

A numbered box located in a post station.

Short postBox

Control 0..*

Type Extension(ADXP Post Box) (Extension Type: string)

Is Modifier false

Summary false

262. Patient.address.line.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

264. Patient.address.city

Definition

The name of the city, town, suburb, village or other community or delivery center.

Short City

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Municpality

Example General: Erewhon

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

266. Patient.address.district

Definition

The name of the administrative area (county).

Short District name (aka county)

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names County

Example General: Madison

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

268. Patient.address.state

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Short Sub-unit of country (abbreviations ok)

Comments

HIQA PS 1.2.4 District/County (Mandatory 1..1).

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Province, Territory

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

270. Patient.address.postalCode

Definition

A postal code designating a region defined by the postal service.

Short Postal code

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Zip

Example General: 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

272. Patient.address.country

Definition

Country - a nation as commonly understood or generally accepted.

Short Country (e.g. can be ISO 3166 2 or 3 letter code)

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

274. Patient.address.country.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

276. Patient.address.country.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

278. Patient.address.country.extension:countryCode

Slice Name countryCode

Definition

Provides a coded expression for the content represented in a string.

Short code for string

Control 0..1

Type Extension(Coded string) (Extension Type: Coding)

Is Modifier false

Summary false

280. Patient.address.country.extension:countryCode.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

282. Patient.address.country.extension:countryCode.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

284. Patient.address.country.extension:countryCode.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-codedString

286. Patient.address.country.extension:countryCode.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1
This element is affected by the following invariants: ext-1

Binding The codes SHOULD be taken from Iso3166-1-2
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

Coding

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

288. Patient.address.country.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

290. Patient.address.period

Definition

Time period when address was/is in use.

Short Time period when address was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows addresses to be placed in historical context.

Example General: { "start" : "2010-03-23", "end" : "2010-07-01" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

292. Patient.maritalStatus

Definition

This field contains a patient's most recent marital (civil) status.

Short Marital status

Comments

Prohibited: not in the HIQA PS dataset.

Control 0..0

Unless not suitable, these codes SHALL be taken from Marital Status Codes
(extensible to http://hl7.org/fhir/ValueSet/marital-status|4.0.1)

The domestic partnership status of a person.

Is Modifier false

Summary false

Requirements

Most, if not all systems capture it.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

294. Patient.multipleBirth[x]

Definition

Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

Short Whether patient is part of a multiple birth

Comments

Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

Control 0..1

Type Choice of: boolean, integer

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

296. Patient.photo

Definition

Image of the patient.

Short Image of the patient

Comments

Guidelines:

Use id photos, not clinical photos.
Limit dimensions to thumbnail.
Keep byte count low to ease resource updates.

Control 0..*

Attachment

Is Modifier false

Summary false

Requirements

Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

298. Patient.contact

Definition

A contact party (e.g. guardian, partner, friend) for the patient.

Short Nominated contact person (HIQA PS Section 3)

Comments

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

Control 0..*

Is Modifier false

Must Support true

Summary false

Requirements

Need to track people you can contact about the patient.

300. Patient.contact.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

302. Patient.contact.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

304. Patient.contact.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

306. Patient.contact.relationship

Definition

The nature of the relationship between the patient and the contact person.

Short Contact relationship

Comments

HIQA PS 3.3 Role (Required 0..*) and 3.4 Relationship (Required 0..1).

Control 0..*

Unless not suitable, these codes SHALL be taken from PatientContactRelationship
(extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)

The nature of the relationship between a patient and a contact person for that patient.

Is Modifier false

Must Support true

Summary false

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

308. Patient.contact.name

Definition

A name associated with the contact person.

Short Contact name

Control 0..1

Is Modifier false

Must Support true

Summary false

Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

310. Patient.contact.name.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

312. Patient.contact.name.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

314. Patient.contact.name.use

Definition

Identifies the purpose for this name.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from NameUse
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

316. Patient.contact.name.text

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Short Text representation of the full name

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

318. Patient.contact.name.family

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Short Family name (often called 'Surname')

Comments

HIQA PS 3.2 Surname of nominated contact person (Required 0..1).

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names surname

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

320. Patient.contact.name.given

Definition

Given name.

Short Given names (not always 'first'). Includes middle names

Comments

HIQA PS 3.1 Forename of nominated contact person (Required 0..1).

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names first name, middle name

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

322. Patient.contact.name.prefix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Short Parts that come before the name

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

324. Patient.contact.name.suffix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Short Parts that come after the name

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

326. Patient.contact.name.period

Definition

Indicates the period of time when this name was valid for the named person.

Short Time period when name was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows names to be placed in historical context.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

328. Patient.contact.telecom

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Short Contact details for the person

Comments

HIQA PS 3.5 Communication details (Required): 3.5.1 mobile, 3.5.2 landline, 3.5.3 email.

Control 0..*

Is Modifier false

Must Support true

Summary false

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

330. Patient.contact.telecom.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

332. Patient.contact.telecom.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

334. Patient.contact.telecom.system

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Short phone | fax | email | pager | url | sms | other

Control 0..1
This element is affected by the following invariants: cpt-2

The codes SHALL be taken from ContactPointSystem
(required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

Telecommunications form for contact point.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

336. Patient.contact.telecom.value

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Short The actual contact point details

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

338. Patient.contact.telecom.use

Definition

Identifies the purpose for the contact point.

Short home | work | temp | old | mobile - purpose of this contact point

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from ContactPointUse
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

Use of contact point.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

340. Patient.contact.telecom.rank

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Short Specify preferred order of use (1 = highest)

Comments

HIQA PS 3.7 Preferred communication type for the nominated contact person (Required): rank = 1.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

342. Patient.contact.telecom.period

Definition

Time period when the contact point was/is in use.

Short Time period when the contact point was/is in use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

344. Patient.contact.address

Definition

Address for the contact person.

Short Contact person address

Comments

HIQA PS 3.6 Address of nominated contact person (Optional 0..1).

Control 0..1

Type Address(Address (EU))

Is Modifier false

Summary false

Requirements

Need to keep track where the contact person can be contacted per postal mail or visited.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

346. Patient.contact.address.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

348. Patient.contact.address.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.contact.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

350. Patient.contact.address.use

Definition

The purpose of this address.

Short Purpose of this address

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from AddressUse
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General: home

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

352. Patient.contact.address.type

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Short Address type (postal | physical)

Comments

Control 0..1

The codes SHALL be taken from AddressType
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: both

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

354. Patient.contact.address.text

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Short Text representation of the address

Comments

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Example General: 137 Nowhere Street, Erewhon 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

356. Patient.contact.address.line

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Short Street name, number, direction & P.O. Box etc.

Comments

HIQA PS 3.6.2 Address line(s): Mandatory when the contact address is given.

Control 1..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 137 Nowhere Street

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

358. Patient.contact.address.line.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

360. Patient.contact.address.line.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.contact.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

362. Patient.contact.address.line.extension:streetName

Slice Name streetName

Definition

streetName.

Short streetName

Control 0..*

Type Extension(ADXP Street Name) (Extension Type: string)

Is Modifier false

Summary false

364. Patient.contact.address.line.extension:houseNumber

Slice Name houseNumber

Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Short houseNumber

Control 0..*

Type Extension(ADXP House Number) (Extension Type: string)

Is Modifier false

Summary false

366. Patient.contact.address.line.extension:postBox

Slice Name postBox

Definition

A numbered box located in a post station.

Short postBox

Control 0..*

Type Extension(ADXP Post Box) (Extension Type: string)

Is Modifier false

Summary false

368. Patient.contact.address.line.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

370. Patient.contact.address.city

Definition

The name of the city, town, suburb, village or other community or delivery center.

Short City

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Municpality

Example General: Erewhon

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

372. Patient.contact.address.district

Definition

The name of the administrative area (county).

Short District name (aka county)

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names County

Example General: Madison

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

374. Patient.contact.address.state

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Short Sub-unit of country (abbreviations ok)

Comments

HIQA PS 3.6.4 District/County/City: Mandatory when the contact address is given.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Province, Territory

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

376. Patient.contact.address.postalCode

Definition

A postal code designating a region defined by the postal service.

Short Postal code

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Zip

Example General: 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

378. Patient.contact.address.country

Definition

Country - a nation as commonly understood or generally accepted.

Short Country (e.g. can be ISO 3166 2 or 3 letter code)

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

380. Patient.contact.address.country.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

382. Patient.contact.address.country.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.contact.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

384. Patient.contact.address.country.extension:countryCode

Slice Name countryCode

Definition

Provides a coded expression for the content represented in a string.

Short code for string

Control 0..1

Type Extension(Coded string) (Extension Type: Coding)

Is Modifier false

Summary false

386. Patient.contact.address.country.extension:countryCode.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

388. Patient.contact.address.country.extension:countryCode.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.contact.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

390. Patient.contact.address.country.extension:countryCode.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-codedString

392. Patient.contact.address.country.extension:countryCode.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1
This element is affected by the following invariants: ext-1

Binding The codes SHOULD be taken from Iso3166-1-2
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

Coding

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

394. Patient.contact.address.country.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

396. Patient.contact.address.period

Definition

Time period when address was/is in use.

Short Time period when address was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows addresses to be placed in historical context.

Example General: { "start" : "2010-03-23", "end" : "2010-07-01" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

398. Patient.contact.gender

Definition

Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

Short male | female | other | unknown

Control 0..1

The codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

Needed to address the person correctly.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

400. Patient.contact.organization

Definition

Organization on behalf of which the contact is acting or for which the contact is working.

Short Organization that is associated with the contact

Control 0..1
This element is affected by the following invariants: pat-1

Type Reference(Organization)

Is Modifier false

Summary false

Requirements

For guardians or business related contacts, the organization is relevant.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

402. Patient.contact.period

Definition

The period during which this contact person or organization is valid to be contacted relating to this patient.

Short The period during which this contact person or organization is valid to be contacted relating to this patient

Control 0..1

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

404. Patient.communication

Definition

A language which may be used to communicate with the patient about his or her health.

Short A language which may be used to communicate with the patient about his or her health

Comments

HIQA PS 1.4.9 Preferred language (Optional 0..*), including sign language.

Control 0..*

Is Modifier false

Must Support true

Summary false

Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

406. Patient.communication.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

408. Patient.communication.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

410. Patient.communication.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

412. Patient.communication.language

Definition

Short Communication language

Comments

Control 1..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Must Support true

Summary false

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

414. Patient.communication.preferred

Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Short Language preference indicator

Comments

This language is specifically identified for communicating healthcare information.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

416. Patient.generalPractitioner

Definition

Patient's nominated care provider.

Short Patient's nominated primary care provider.

Comments

HIQA PS Section 2: General Practitioner details must be captured in all cases.

Control 0..*

Type Reference(Organization (EU core), PractitionerRole (EU core), Practitioner (EU core))

Is Modifier false

Must Support true

Must Support Types No must-support rules about the choice of types/profiles

Obligations

Obligations

Actor

Source

SHALL:populate-if-known

SHALL:handle

SHOULD:display

Summary false

Alternate Names careProvider

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

418. Patient.managingOrganization

Definition

Organization that is the custodian of the patient record.

Short Organization that is the custodian of the patient record

Comments

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Requirements

Need to know who recognizes this patient record, manages and updates it.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

420. Patient.link

Definition

Link to another patient resource that concerns the same actual patient.

Short Link to another patient resource that concerns the same actual person

Comments

There is no assumption that linked patient records have mutual links.

Control 0..*

Summary true

Requirements

There are multiple use cases:

Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
Distribution of patient information across multiple servers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

422. Patient.link.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

424. Patient.link.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

426. Patient.link.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

428. Patient.link.other

Definition

The other patient resource that the link refers to.

Short The other patient or related person resource that the link refers to

Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Control 1..1

Type Reference(Patient, RelatedPerson)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

430. Patient.link.type

Definition

The type of link between this patient resource and another patient resource.

Short replaced-by | replaces | refer | seealso

Control 1..1

The codes SHALL be taken from LinkType
(required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

The type of link between this patient resource and another patient resource.