IE Medication Events Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: IE MPD Patient (ePrescription/eDispensation)

The patient as the subject of an ePrescription or eDispensation. It carries the HIQA ePrescription/eDispensation patient dataset (Section 1) and nothing more. Ethnicity, mother's maiden name, nationality, citizenship, place of birth, religion, marital status, pronouns, photo and contact persons are not part of that dataset, so they are prohibited (GDPR Art. 5(1)(c) data minimisation; ethnicity and religion are Art. 9 special-category data). Patient identity is established by the IHI (when available) together with name, date of birth and address (see the clinical-safety log, IE Core HZ-06).

Usages:

• Use this Profile: IE MPD Bundle (ePrescription)
• Refer to this Profile: IE MPD Allergy Statement at Prescribing, IE MPD MedicationDispense (eDispensation) and IE MPD MedicationRequest (ePrescription)
• Examples for this Profile: Patient/hiqa-patient-declan-walsh, Patient/hiqa-patient-niamh-keane, Patient/hiqa-patient-oisin-brady and Patient/hiqa-patient-tomas-quinn

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IEMpdPatient(0.1.0)	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Constraints: ext-1
extension:gender-identity	S	0..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime Constraints: ext-1
extension:sexAssignedAtBirth	S	1..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension				Content/Rules for all slices
extension:value		1..1	Extension	The recorded sex or gender property for the individual Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example)
extension:type		1..1	Extension	Extension Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: RecordedSexOrGenderType (2.0.0) (example) Required Pattern: At least the following
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"effectivePeriod"
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: JurisdictionValueSet (1.0.0) (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
Slices for identifier	SΣ	0..*	Identifier	Identifiers for this patient Slice: Unordered, Open by value:system
identifier:IHI	SΣC	0..1	Identifier	Individual Health Identifier (IHI) Constraints: ie-pat-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi
value	SΣ	1..1	string	IHI number (18 or 10 digits) Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:PPSN	SΣC	0..1	Identifier	Personal Public Service Number (PPSN): Requires Clarification Constraints: ie-pat-ppsn-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	1..1	string	Family name (surname) Example spanish: Valero Iglesias
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the patient
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	Administrative gender (not sex assigned at birth) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	AddressEu(2.0.0)	An address for the patient (Irish address)
use	?!SΣ	1..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	Address type (postal | physical) Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	1..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
Slices for extension				Content/Rules for all slices
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints: ext-1
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints: ext-1
extension:postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints: ext-1
city	SΣ	0..1	string	Suburb, town, townland or locality (Dublin postal district, e.g. 'Dublin 2', goes here) Example General: Erewhon
state	SΣ	1..1	string	County Binding: IEMpdCounties (0.1.0) (extensible)
postalCode	SΣ	0..1	string	Eircode or postal code (Eircode format XXX XXXX) Example General: 9132
country	SΣ	0..1	string	Country (ISO 3166-1 alpha-2)
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: Iso3166-1-2 (preferred)
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
language	S	1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
generalPractitioner	S	0..*	Reference(IE MPD Organization(0.1.0) | IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0))	Patient's nominated primary care provider.
managingOrganization	SΣ	0..1	Reference(IE MPD Organization(0.1.0))	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:sexAssignedAtBirth.​extension:value.value[x]	Base	example	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.extension:sexAssignedAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📍2.0.0	THO v7.4
Patient.extension:sexAssignedAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📍1.0.0	THO v7.4
Patient.identifier:IHI.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:IHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:PPSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	Ireland Counties	📍0.1.0	This IG
Patient.address.country.​extension:countryCode.​value[x]	Base	preferred	Iso 3166 Part 1: 2 Letter Codes	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Patient.implicitRules, Patient.extension, Patient.extension:birthPlace.value[x], Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:value.value[x], Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:type.value[x], Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.value[x], Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:source.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceDocument.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:sourceField.value[x], Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:jurisdiction.value[x], Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:comment.value[x], Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:IHI, Patient.identifier:IHI.use, Patient.identifier:IHI.type, Patient.identifier:IHI.system, Patient.identifier:IHI.value, Patient.identifier:IHI.period, Patient.identifier:IHI.assigner, Patient.identifier:PPSN, Patient.identifier:PPSN.use, Patient.identifier:PPSN.system, Patient.identifier:PPSN.value, Patient.active, Patient.name, Patient.name.use, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.telecom, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.use, Patient.address.type, Patient.address.line, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.city, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.value[x], Patient.contact.modifierExtension, Patient.communication, Patient.communication.modifierExtension, Patient.communication.language, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
eu-pat-1	error	Patient.name	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()
ext-1	error	Patient.extension, Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.modifierExtension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.country.extension:countryCode, Patient.contact.modifierExtension, Patient.communication.modifierExtension, Patient.link.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-pat-1	error	Patient.identifier:IHI	IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number')	value.matches('^([0-9]{18}|[0-9]{10})$')
ie-pat-ppsn-1	warning	Patient.identifier:PPSN	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}$')

This structure is derived from IEMpdPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			IEMpdPatient(0.1.0)
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..0		Place of Birth for patient
extension:gender-identity		0..1	PGenderIdentity(5.2.0)	The individual's gender identity
extension:pronouns		0..0		The pronouns to use when communicating about an individual.
extension:patient-citizenship		0..0		Nation(s) where the patient claims citizenship
extension:patient-nationality		0..0		Nationality
extension:sexAssignedAtBirth		1..1	RecordedSexOrGender(5.2.0)	A recorded sex or gender property for the individual
extension:ethnicity		0..0		IE MPD Ethnicity
extension:mothersMaidenName		0..0		Mother's Maiden name
extension:interpreterRequired		0..0		Whether an interpreter is required
extension:religion		0..0	CodeableConcept	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (preferred)
extension:mothersFormerSurname		0..0	string	IE MPD Mother's Former Surname URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-mothers-former-surname
extension:countryOfAffiliation		0..0	CodeableConcept	IE MPD Country of Affiliation URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-country-of-affiliation Binding: Iso3166-1-2 (required)
Slices for identifier				Content/Rules for all slices
identifier:IHI		0..1	Identifier	Individual Health Identifier (IHI)
identifier:PPSN	C	0..1	Identifier	Personal Public Service Number (PPSN): Requires Clarification
system		1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps
value		1..1	string	The value that is unique
name
family		1..1	string	Family name (surname)
given		1..*	string	Given names (first and middle names)
prefix		0..*	string	Parts that come before the name
suffix		0..*	string	Parts that come after the name
telecom		0..*	ContactPoint	A contact detail for the patient
birthDate		1..1	date	The date of birth for the patient
address		1..*	AddressEu(2.0.0)	An address for the patient (Irish address)
use		1..1	code	Purpose of this address
type		0..1	code	Address type (postal | physical)
line		1..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Suburb, town, townland or locality (Dublin postal district, e.g. 'Dublin 2', goes here)
state		1..1	string	County
postalCode		0..1	string	Eircode or postal code (Eircode format XXX XXXX)
country		0..1	string	Country (ISO 3166-1 alpha-2)
maritalStatus		0..0		Marital status
multipleBirth[x]		0..0		Whether patient is part of a multiple birth
photo		0..0		Image of the patient
contact		0..0		A contact party (e.g. guardian, partner, friend) for the patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ie-pat-ppsn-1	warning	Patient.identifier:PPSN	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}$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IEMpdPatient(0.1.0)	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Constraints: ext-1
extension:gender-identity	S	0..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime Constraints: ext-1
extension:sexAssignedAtBirth	S	1..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension				Content/Rules for all slices
extension:value		1..1	Extension	The recorded sex or gender property for the individual Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example)
extension:type		1..1	Extension	Extension Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: RecordedSexOrGenderType (2.0.0) (example) Required Pattern: At least the following
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"effectivePeriod"
value[x]		0..1	Period	Value of extension
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: JurisdictionValueSet (1.0.0) (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
Slices for identifier	SΣ	0..*	Identifier	Identifiers for this patient Slice: Unordered, Open by value:system
identifier:IHI	SΣC	0..1	Identifier	Individual Health Identifier (IHI) Constraints: ie-pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi
value	SΣ	1..1	string	IHI number (18 or 10 digits) Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:PPSN	SΣC	0..1	Identifier	Personal Public Service Number (PPSN): Requires Clarification Constraints: ie-pat-ppsn-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name.
family	SΣ	1..1	string	Family name (surname) Example spanish: Valero Iglesias
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	Administrative gender (not sex assigned at birth) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	AddressEu(2.0.0)	An address for the patient (Irish address)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!SΣ	1..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	Address type (postal | physical) Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	1..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints: ext-1
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints: ext-1
extension:postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints: ext-1
value		0..1	string	Primitive value for string Max Length:1048576
city	SΣ	0..1	string	Suburb, town, townland or locality (Dublin postal district, e.g. 'Dublin 2', goes here) Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	County Binding: IEMpdCounties (0.1.0) (extensible)
postalCode	SΣ	0..1	string	Eircode or postal code (Eircode format XXX XXXX) Example General: 9132
country	SΣ	0..1	string	Country (ISO 3166-1 alpha-2)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: Iso3166-1-2 (preferred)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
language	S	1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(IE MPD Organization(0.1.0) | IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0))	Patient's nominated primary care provider.
managingOrganization	SΣ	0..1	Reference(IE MPD Organization(0.1.0))	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.extension:sexAssignedAtBirth.​extension:value.value[x]	Base	example	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.extension:sexAssignedAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📍2.0.0	THO v7.4
Patient.extension:sexAssignedAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📍1.0.0	THO v7.4
Patient.identifier:IHI.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:IHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:PPSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PPSN.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	Ireland Counties	📍0.1.0	This IG
Patient.address.country.​extension:countryCode.​value[x]	Base	preferred	Iso 3166 Part 1: 2 Letter Codes	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:birthPlace.value[x], Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:value.value[x], Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:type.value[x], Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.value[x], Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.value[x], Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:source.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceDocument.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:sourceField.value[x], Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:jurisdiction.value[x], Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:comment.value[x], Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:IHI, Patient.identifier:IHI.extension, Patient.identifier:IHI.use, Patient.identifier:IHI.type, Patient.identifier:IHI.system, Patient.identifier:IHI.value, Patient.identifier:IHI.period, Patient.identifier:IHI.assigner, Patient.identifier:PPSN, Patient.identifier:PPSN.extension, Patient.identifier:PPSN.use, Patient.identifier:PPSN.type, Patient.identifier:PPSN.system, Patient.identifier:PPSN.value, Patient.identifier:PPSN.period, Patient.identifier:PPSN.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.value[x], Patient.address.period, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.telecom, Patient.contact.address, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
eu-pat-1	error	Patient.name	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()
ext-1	error	Patient.extension, Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.modifierExtension, Patient.identifier:IHI.extension, Patient.identifier:PPSN.extension, Patient.name.extension, Patient.telecom.extension, Patient.address.extension, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.contact.extension, Patient.contact.modifierExtension, Patient.communication.extension, Patient.communication.modifierExtension, Patient.link.extension, Patient.link.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-pat-1	error	Patient.identifier:IHI	IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number')	value.matches('^([0-9]{18}|[0-9]{10})$')
ie-pat-ppsn-1	warning	Patient.identifier:PPSN	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}$')

This structure is derived from IEMpdPatient

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Prohibited: 14 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-religion|5.2.0
• https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-mothers-former-surname|0.1.0
• https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-country-of-affiliation|0.1.0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IEMpdPatient(0.1.0)	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Constraints: ext-1
extension:gender-identity	S	0..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime Constraints: ext-1
extension:sexAssignedAtBirth	S	1..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension				Content/Rules for all slices
extension:value		1..1	Extension	The recorded sex or gender property for the individual Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example)
extension:type		1..1	Extension	Extension Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: RecordedSexOrGenderType (2.0.0) (example) Required Pattern: At least the following
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"effectivePeriod"
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: JurisdictionValueSet (1.0.0) (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element. Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
Slices for identifier	SΣ	0..*	Identifier	Identifiers for this patient Slice: Unordered, Open by value:system
identifier:IHI	SΣC	0..1	Identifier	Individual Health Identifier (IHI) Constraints: ie-pat-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi
value	SΣ	1..1	string	IHI number (18 or 10 digits) Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:PPSN	SΣC	0..1	Identifier	Personal Public Service Number (PPSN): Requires Clarification Constraints: ie-pat-ppsn-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	1..1	string	Family name (surname) Example spanish: Valero Iglesias
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the patient
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	Administrative gender (not sex assigned at birth) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	AddressEu(2.0.0)	An address for the patient (Irish address)
use	?!SΣ	1..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	Address type (postal | physical) Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	1..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
Slices for extension				Content/Rules for all slices
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints: ext-1
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints: ext-1
extension:postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints: ext-1
city	SΣ	0..1	string	Suburb, town, townland or locality (Dublin postal district, e.g. 'Dublin 2', goes here) Example General: Erewhon
state	SΣ	1..1	string	County Binding: IEMpdCounties (0.1.0) (extensible)
postalCode	SΣ	0..1	string	Eircode or postal code (Eircode format XXX XXXX) Example General: 9132
country	SΣ	0..1	string	Country (ISO 3166-1 alpha-2)
Slices for extension				Content/Rules for all slices
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: Iso3166-1-2 (preferred)
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
language	S	1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
generalPractitioner	S	0..*	Reference(IE MPD Organization(0.1.0) | IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0))	Patient's nominated primary care provider.
managingOrganization	SΣ	0..1	Reference(IE MPD Organization(0.1.0))	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:sexAssignedAtBirth.​extension:value.value[x]	Base	example	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.extension:sexAssignedAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📍2.0.0	THO v7.4
Patient.extension:sexAssignedAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📍1.0.0	THO v7.4
Patient.identifier:IHI.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:IHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:PPSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	Ireland Counties	📍0.1.0	This IG
Patient.address.country.​extension:countryCode.​value[x]	Base	preferred	Iso 3166 Part 1: 2 Letter Codes	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Patient.implicitRules, Patient.extension, Patient.extension:birthPlace.value[x], Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:value.value[x], Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:type.value[x], Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.value[x], Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:source.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceDocument.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:sourceField.value[x], Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:jurisdiction.value[x], Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:comment.value[x], Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:IHI, Patient.identifier:IHI.use, Patient.identifier:IHI.type, Patient.identifier:IHI.system, Patient.identifier:IHI.value, Patient.identifier:IHI.period, Patient.identifier:IHI.assigner, Patient.identifier:PPSN, Patient.identifier:PPSN.use, Patient.identifier:PPSN.system, Patient.identifier:PPSN.value, Patient.active, Patient.name, Patient.name.use, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.telecom, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.use, Patient.address.type, Patient.address.line, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.city, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.value[x], Patient.contact.modifierExtension, Patient.communication, Patient.communication.modifierExtension, Patient.communication.language, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
eu-pat-1	error	Patient.name	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()
ext-1	error	Patient.extension, Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.modifierExtension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.country.extension:countryCode, Patient.contact.modifierExtension, Patient.communication.modifierExtension, Patient.link.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-pat-1	error	Patient.identifier:IHI	IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number')	value.matches('^([0-9]{18}|[0-9]{10})$')
ie-pat-ppsn-1	warning	Patient.identifier:PPSN	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}$')

Differential View

This structure is derived from IEMpdPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			IEMpdPatient(0.1.0)
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..0		Place of Birth for patient
extension:gender-identity		0..1	PGenderIdentity(5.2.0)	The individual's gender identity
extension:pronouns		0..0		The pronouns to use when communicating about an individual.
extension:patient-citizenship		0..0		Nation(s) where the patient claims citizenship
extension:patient-nationality		0..0		Nationality
extension:sexAssignedAtBirth		1..1	RecordedSexOrGender(5.2.0)	A recorded sex or gender property for the individual
extension:ethnicity		0..0		IE MPD Ethnicity
extension:mothersMaidenName		0..0		Mother's Maiden name
extension:interpreterRequired		0..0		Whether an interpreter is required
extension:religion		0..0	CodeableConcept	The patient's professed religious affiliations URL: http://hl7.org/fhir/StructureDefinition/patient-religion Binding: ReligiousAffiliation (preferred)
extension:mothersFormerSurname		0..0	string	IE MPD Mother's Former Surname URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-mothers-former-surname
extension:countryOfAffiliation		0..0	CodeableConcept	IE MPD Country of Affiliation URL: https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-country-of-affiliation Binding: Iso3166-1-2 (required)
Slices for identifier				Content/Rules for all slices
identifier:IHI		0..1	Identifier	Individual Health Identifier (IHI)
identifier:PPSN	C	0..1	Identifier	Personal Public Service Number (PPSN): Requires Clarification
system		1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps
value		1..1	string	The value that is unique
name
family		1..1	string	Family name (surname)
given		1..*	string	Given names (first and middle names)
prefix		0..*	string	Parts that come before the name
suffix		0..*	string	Parts that come after the name
telecom		0..*	ContactPoint	A contact detail for the patient
birthDate		1..1	date	The date of birth for the patient
address		1..*	AddressEu(2.0.0)	An address for the patient (Irish address)
use		1..1	code	Purpose of this address
type		0..1	code	Address type (postal | physical)
line		1..*	string	Street name, number, direction & P.O. Box etc.
city		0..1	string	Suburb, town, townland or locality (Dublin postal district, e.g. 'Dublin 2', goes here)
state		1..1	string	County
postalCode		0..1	string	Eircode or postal code (Eircode format XXX XXXX)
country		0..1	string	Country (ISO 3166-1 alpha-2)
maritalStatus		0..0		Marital status
multipleBirth[x]		0..0		Whether patient is part of a multiple birth
photo		0..0		Image of the patient
contact		0..0		A contact party (e.g. guardian, partner, friend) for the patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ie-pat-ppsn-1	warning	Patient.identifier:PPSN	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}$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IEMpdPatient(0.1.0)	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Constraints: ext-1
extension:gender-identity	S	0..1	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime Constraints: ext-1
extension:sexAssignedAtBirth	S	1..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension				Content/Rules for all slices
extension:value		1..1	Extension	The recorded sex or gender property for the individual Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example)
extension:type		1..1	Extension	Extension Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: RecordedSexOrGenderType (2.0.0) (example) Required Pattern: At least the following
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"effectivePeriod"
value[x]		0..1	Period	Value of extension
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: JurisdictionValueSet (1.0.0) (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element. Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
Slices for identifier	SΣ	0..*	Identifier	Identifiers for this patient Slice: Unordered, Open by value:system
identifier:IHI	SΣC	0..1	Identifier	Individual Health Identifier (IHI) Constraints: ie-pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi
value	SΣ	1..1	string	IHI number (18 or 10 digits) Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:PPSN	SΣC	0..1	Identifier	Personal Public Service Number (PPSN): Requires Clarification Constraints: ie-pat-ppsn-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: eu-pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name.
family	SΣ	1..1	string	Family name (surname) Example spanish: Valero Iglesias
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	Administrative gender (not sex assigned at birth) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	AddressEu(2.0.0)	An address for the patient (Irish address)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!SΣ	1..1	code	Purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	Address type (postal | physical) Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	1..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:streetName		0..*	string	streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints: ext-1
extension:houseNumber		0..*	string	houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints: ext-1
extension:postBox		0..*	string	postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints: ext-1
value		0..1	string	Primitive value for string Max Length:1048576
city	SΣ	0..1	string	Suburb, town, townland or locality (Dublin postal district, e.g. 'Dublin 2', goes here) Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	County Binding: IEMpdCounties (0.1.0) (extensible)
postalCode	SΣ	0..1	string	Eircode or postal code (Eircode format XXX XXXX) Example General: 9132
country	SΣ	0..1	string	Country (ISO 3166-1 alpha-2)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:countryCode		0..1	(Complex)	code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString Constraints: ext-1
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
value[x]		1..1	Coding	Value of extension Binding: Iso3166-1-2 (preferred)
value		0..1	string	Primitive value for string Max Length:1048576
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
language	S	1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(IE MPD Organization(0.1.0) | IE MPD Practitioner(0.1.0) | IE MPD PractitionerRole(0.1.0))	Patient's nominated primary care provider.
managingOrganization	SΣ	0..1	Reference(IE MPD Organization(0.1.0))	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.extension:sexAssignedAtBirth.​extension:value.value[x]	Base	example	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.extension:sexAssignedAtBirth.​extension:type.value[x]	Base	example	Recorded Sex Or Gender Type	📍2.0.0	THO v7.4
Patient.extension:sexAssignedAtBirth.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📍1.0.0	THO v7.4
Patient.identifier:IHI.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:IHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:PPSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PPSN.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	extensible	Ireland Counties	📍0.1.0	This IG
Patient.address.country.​extension:countryCode.​value[x]	Base	preferred	Iso 3166 Part 1: 2 Letter Codes	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:birthPlace.value[x], Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:value.value[x], Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:type.value[x], Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:effectivePeriod.value[x], Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate.value[x], Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:source.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceDocument.value[x], Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:sourceField.value[x], Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:jurisdiction.value[x], Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:comment.value[x], Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:IHI, Patient.identifier:IHI.extension, Patient.identifier:IHI.use, Patient.identifier:IHI.type, Patient.identifier:IHI.system, Patient.identifier:IHI.value, Patient.identifier:IHI.period, Patient.identifier:IHI.assigner, Patient.identifier:PPSN, Patient.identifier:PPSN.extension, Patient.identifier:PPSN.use, Patient.identifier:PPSN.type, Patient.identifier:PPSN.system, Patient.identifier:PPSN.value, Patient.identifier:PPSN.period, Patient.identifier:PPSN.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.value[x], Patient.address.period, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.telecom, Patient.contact.address, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
eu-pat-1	error	Patient.name	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()
ext-1	error	Patient.extension, Patient.extension:sex-for-clinical-use, Patient.extension:gender-identity, Patient.extension:birthTime, Patient.extension:sexAssignedAtBirth, Patient.extension:sexAssignedAtBirth.extension, Patient.extension:sexAssignedAtBirth.extension:value, Patient.extension:sexAssignedAtBirth.extension:type, Patient.extension:sexAssignedAtBirth.extension:effectivePeriod, Patient.extension:sexAssignedAtBirth.extension:acquisitionDate, Patient.extension:sexAssignedAtBirth.extension:source, Patient.extension:sexAssignedAtBirth.extension:sourceDocument, Patient.extension:sexAssignedAtBirth.extension:sourceField, Patient.extension:sexAssignedAtBirth.extension:jurisdiction, Patient.extension:sexAssignedAtBirth.extension:comment, Patient.extension:sexAssignedAtBirth.extension:genderElementQualifier, Patient.modifierExtension, Patient.identifier:IHI.extension, Patient.identifier:PPSN.extension, Patient.name.extension, Patient.telecom.extension, Patient.address.extension, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:postBox, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.contact.extension, Patient.contact.modifierExtension, Patient.communication.extension, Patient.communication.modifierExtension, Patient.link.extension, Patient.link.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ie-pat-1	error	Patient.identifier:IHI	IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number')	value.matches('^([0-9]{18}|[0-9]{10})$')
ie-pat-ppsn-1	warning	Patient.identifier:PPSN	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}$')

This structure is derived from IEMpdPatient

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Prohibited: 14 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-religion|5.2.0
• https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-mothers-former-surname|0.1.0
• https://hl7-ie.github.io/medication-events/fhir/StructureDefinition/ie-mpd-country-of-affiliation|0.1.0