IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot Ireland flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: IE Core Patient Profile

Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-patient Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: IECorePatientProfile
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.46

Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License

The IE Core Patient Profile inherits from the FHIR Patient resource; refer to it for scope and usage definitions. This profile meets the requirements of the iEHR IE Core Data for Interoperability (IECDI) Patient Demographics/Information Data Class. It sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for Patient demographic information using Medical Record Number (MRN), which is a type of identifier. The MRN is identifiable by identifier.system and may be location specific.
  • Query for Patient demographic information using first name, last name, birthdate, and gender.

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Patient Must Have:

  1. a patient identifier (e.g., IHI)
  2. a patient name
  3. a gender*

Each Patient Must Support:

  1. a birth date
  2. an address*

Additional IECDI Requirements:

These Additional IECDI Requirements elements are not Mandatory or Must Support but are required for certification testing and are included in the formal definition of the profile and the Patient examples.

  1. contact detail (e.g., a telephone number or an email address)
  2. a communication language*
  3. interpreter required flag*
  4. mother's maiden name
  5. an ethnicity*
  6. gender identity*
  7. personal pronouns
  8. date of death*
  9. address use*
  10. address period*
  11. name use*
  12. name period*
  13. suffix*

*see guidance below

Profile Specific Implementation Guidance:

  • Notes for Ethnicity, Date of Death, Name to Use, Previous Name, Suffix, Previous Address, Interpreter Needed, and Preferred Language IECDI Data Elements:
    • The Complex Extensions for Ethnicity allow for one or more codes of which:
      • Must Support at least one category code from the Ethnicity Categories
      • MAY include additional detailed codes from Ethnicity Codes
      • SHALL include a text description
    • Date of Death is communicated using the Patient.deceasedDateTime element.
      • Although Patient.deceased[x] is marked as π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—œπ—˜π—–π——π—œ, certifying systems are not required to support both, but SHALL support at least Patient.deceasedDateTime
    • Name to Use is represented by setting Patient.name.use to "usual".
    • Previous name is represented by setting Patient.name.use to "old" or providing an end date in Patient.name.period or doing both.
    • Suffix is represented using the Patient.name.suffix element.
    • Previous Address is represented by setting Patient.address.use to "old" or providing an end date in Patient.address.period or doing both.
    • Servers can use the IE Core Interpreter Required Extension on the IE Core Patient or [IE Core Encounter Profiles] to communicate whether a patient needs an interpreter. Although the extension is marked as an Additional IECDI Requirement on both IE Core Patient and IE Core Encounter Profiles, the certifying server system is not required to support the extension on both profiles but SHALL support the extension on at least one. The certifying client application SHALL support the extension on both profiles.
      • When multiple languages are represented, systems MAY designate the patient's Preferred Language in the Communication.preferred element or by using the FHIR standard Patient Proficiency Extension and infer a patient's language service needs from it.
    • The Patient example demonstrates how these elements are represented.

  • Certifying systems SHALL and non-certifying systems SHOULD follow the Project IE@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for Patient.address.line and Patient.address.city for new and updated records.

    • For certifying systems, this requirement does not apply to historical records or documents that are exposed through FHIR-based APIs.
  • Provenance and the FHIR Extension Target Element can document how individual patient demographic data was captured. See Element Level Provenance on the Basic Provenance page for more information.
  • The Patient's Social Security Numbers (i.e. PPS) SHOULD NOT be used as a patient identifier in Patient.identifier.value. There is increasing concern over using Social Security Numbers (i.e. PPS) in healthcare due to the risk of identity theft and related issues. Many payers and providers have purged them from their systems and filtered them out of incoming data.

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
ie-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
ie-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ethnicity 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ethnicity
Binding: IE Core ethnicity (required): Code for ethnicity

.... motherMaidenName 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Patient's Mother's Maiden Name
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-patient-mother-maiden-name
.... genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: The individual's gender identity
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-genderIdentity
Binding: IE Core Gender Identity (extensible)
.... personalPronouns 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Individual's Pronouns Extension
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Interpreter Required
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required
Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns

... Slices for identifier S 1..* IECoreIndividualHealthcareIdentifier, IECoreMedicalRecordNumber, IECoreInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:system
.... identifier:IHI SC 0..1 IECoreIndividualHealthcareIdentifier Individual Healthcare Identifier (IHI)
.... identifier:MRN S 0..1 IECoreMedicalRecordNumber Medical Record Number (MRN)
.... identifier:IMN S 0..1 IECoreInsuranceMemberNumber Insurance Member Number (IMN)
... name S 1..* HumanName A name associated with the patient
.... use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
.... family S 0..1 string Family name (often called 'Surname')
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... suffix 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Parts that come after the name
.... period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when name was/is in use
... telecom 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A contact detail for the individual
.... system S 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)
... gender S 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S 0..1 date The date of birth for the individual
... deceased[x] 0..1 boolean, dateTime 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Indicates if the individual is deceased or not
... address S 0..* Address An address for the individual
.... use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
Example General: 51 Bracken Rd
.... city S 0..1 string Name of city, town etc.
Example General: Sandyford
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode S 0..1 string IE Eircodes
Example General: D18 CV48
.... period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when address was/is in use
... communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://iehr.ai/fhir/ie/core/ValueSet/simple-language
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ie-core-pat-01errorPatientAt least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
: (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ie-core-pat-02errorPatientAt least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
: name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
ie-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
ie-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
... implicitRules ?!Ξ£ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ethnicity 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ethnicity
Binding: IE Core ethnicity (required): Code for ethnicity


.... motherMaidenName 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Patient's Mother's Maiden Name
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-patient-mother-maiden-name
.... genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: The individual's gender identity
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-genderIdentity
Binding: IE Core Gender Identity (extensible)
.... personalPronouns 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Individual's Pronouns Extension
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Interpreter Required
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required
Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΞ£ 1..* IECoreIndividualHealthcareIdentifier, IECoreMedicalRecordNumber, IECoreInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:system
.... identifier:IHI SC 0..1 IECoreIndividualHealthcareIdentifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
.... identifier:MRN S 0..1 IECoreMedicalRecordNumber Medical Record Number (MRN)
.... identifier:IMN S 0..1 IECoreInsuranceMemberNumber Insurance Member Number (IMN)
... active ?!Ξ£ 0..1 boolean Whether this patient's record is in active use
... name SΞ£ 1..* HumanName A name associated with the patient
.... use ?!Ξ£ 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΞ£ 0..1 string Family name (often called 'Surname')
.... given SΞ£ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... suffix Ξ£ 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 Ξ£ 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A contact detail for the individual
.... 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)
... gender SΞ£ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΞ£ 0..1 date The date of birth for the individual
... deceased[x] ?!Ξ£ 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΞ£ 0..* Address An address for the individual
.... use ?!Ξ£ 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΞ£ 0..* 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
Example General: 51 Bracken Rd
.... city SΞ£ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... state SΞ£ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΞ£ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... period Ξ£ 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... communication 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
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
... 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
.... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://iehr.ai/fhir/ie/core/ValueSet/simple-language
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-pat-01errorPatientAt least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
: (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ie-core-pat-02errorPatientAt least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
: name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
ie-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
ie-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ethnicity 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ethnicity
Binding: IE Core ethnicity (required): Code for ethnicity


.... motherMaidenName 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Patient's Mother's Maiden Name
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-patient-mother-maiden-name
.... genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: The individual's gender identity
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-genderIdentity
Binding: IE Core Gender Identity (extensible)
.... personalPronouns 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Individual's Pronouns Extension
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Interpreter Required
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required
Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΞ£ 1..* IECoreIndividualHealthcareIdentifier, IECoreMedicalRecordNumber, IECoreInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:system
.... identifier:IHI SC 0..1 IECoreIndividualHealthcareIdentifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
.... identifier:MRN S 0..1 IECoreMedicalRecordNumber Medical Record Number (MRN)
.... identifier:IMN S 0..1 IECoreInsuranceMemberNumber Insurance Member Number (IMN)
... active ?!Ξ£ 0..1 boolean Whether this patient's record is in active use
... name SΞ£ 1..* HumanName A name associated with 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
.... use ?!Ξ£ 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Ξ£ 0..1 string Family name (often called 'Surname')
.... given SΞ£ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Ξ£ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Ξ£ 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 Ξ£ 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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)
.... 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 male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΞ£ 0..1 date The date of birth for the individual
... deceased[x] ?!Ξ£ 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΞ£ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Ξ£ 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Ξ£ 0..1 code postal | physical | both
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Ξ£ 0..* 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
Example General: 51 Bracken Rd
.... city SΞ£ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... district Ξ£ 0..1 string District name (aka county)
Example General: Madison
.... state SΞ£ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΞ£ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... country Ξ£ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Ξ£ 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 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
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Ξ£ 0..1 Reference(Organization) 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
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://iehr.ai/fhir/ie/core/ValueSet/simple-language
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-pat-01errorPatientAt least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
: (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ie-core-pat-02errorPatientAt least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
: name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
ie-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
ie-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ethnicity 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ethnicity
Binding: IE Core ethnicity (required): Code for ethnicity

.... motherMaidenName 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Patient's Mother's Maiden Name
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-patient-mother-maiden-name
.... genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: The individual's gender identity
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-genderIdentity
Binding: IE Core Gender Identity (extensible)
.... personalPronouns 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Individual's Pronouns Extension
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Interpreter Required
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required
Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns

... Slices for identifier S 1..* IECoreIndividualHealthcareIdentifier, IECoreMedicalRecordNumber, IECoreInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:system
.... identifier:IHI SC 0..1 IECoreIndividualHealthcareIdentifier Individual Healthcare Identifier (IHI)
.... identifier:MRN S 0..1 IECoreMedicalRecordNumber Medical Record Number (MRN)
.... identifier:IMN S 0..1 IECoreInsuranceMemberNumber Insurance Member Number (IMN)
... name S 1..* HumanName A name associated with the patient
.... use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
.... family S 0..1 string Family name (often called 'Surname')
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... suffix 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Parts that come after the name
.... period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when name was/is in use
... telecom 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A contact detail for the individual
.... system S 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)
... gender S 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S 0..1 date The date of birth for the individual
... deceased[x] 0..1 boolean, dateTime 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Indicates if the individual is deceased or not
... address S 0..* Address An address for the individual
.... use 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
Example General: 51 Bracken Rd
.... city S 0..1 string Name of city, town etc.
Example General: Sandyford
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode S 0..1 string IE Eircodes
Example General: D18 CV48
.... period 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when address was/is in use
... communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://iehr.ai/fhir/ie/core/ValueSet/simple-language
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ie-core-pat-01errorPatientAt least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
: (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ie-core-pat-02errorPatientAt least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
: name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
ie-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
ie-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
... implicitRules ?!Ξ£ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ethnicity 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ethnicity
Binding: IE Core ethnicity (required): Code for ethnicity


.... motherMaidenName 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Patient's Mother's Maiden Name
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-patient-mother-maiden-name
.... genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: The individual's gender identity
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-genderIdentity
Binding: IE Core Gender Identity (extensible)
.... personalPronouns 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Individual's Pronouns Extension
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Interpreter Required
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required
Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΞ£ 1..* IECoreIndividualHealthcareIdentifier, IECoreMedicalRecordNumber, IECoreInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:system
.... identifier:IHI SC 0..1 IECoreIndividualHealthcareIdentifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
.... identifier:MRN S 0..1 IECoreMedicalRecordNumber Medical Record Number (MRN)
.... identifier:IMN S 0..1 IECoreInsuranceMemberNumber Insurance Member Number (IMN)
... active ?!Ξ£ 0..1 boolean Whether this patient's record is in active use
... name SΞ£ 1..* HumanName A name associated with the patient
.... use ?!Ξ£ 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΞ£ 0..1 string Family name (often called 'Surname')
.... given SΞ£ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... suffix Ξ£ 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 Ξ£ 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A contact detail for the individual
.... 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)
... gender SΞ£ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΞ£ 0..1 date The date of birth for the individual
... deceased[x] ?!Ξ£ 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΞ£ 0..* Address An address for the individual
.... use ?!Ξ£ 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΞ£ 0..* 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
Example General: 51 Bracken Rd
.... city SΞ£ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... state SΞ£ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΞ£ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... period Ξ£ 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... communication 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
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
... 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
.... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://iehr.ai/fhir/ie/core/ValueSet/simple-language
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-pat-01errorPatientAt least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
: (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ie-core-pat-02errorPatientAt least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
: name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
ie-core-pat-01: At least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
ie-core-pat-02: At least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ethnicity 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ethnicity
Binding: IE Core ethnicity (required): Code for ethnicity


.... motherMaidenName 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Patient's Mother's Maiden Name
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-patient-mother-maiden-name
.... genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: The individual's gender identity
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-genderIdentity
Binding: IE Core Gender Identity (extensible)
.... personalPronouns 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Individual's Pronouns Extension
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: IE Core Interpreter Required
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-interpreter-required
Binding: IE Core Yes, No, and Unknowns (required): Answer Set with Yes No and Unknowns


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΞ£ 1..* IECoreIndividualHealthcareIdentifier, IECoreMedicalRecordNumber, IECoreInsuranceMemberNumber Identifies this patient across multiple systems
Slice: Unordered, Open by pattern:system
.... identifier:IHI SC 0..1 IECoreIndividualHealthcareIdentifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
.... identifier:MRN S 0..1 IECoreMedicalRecordNumber Medical Record Number (MRN)
.... identifier:IMN S 0..1 IECoreInsuranceMemberNumber Insurance Member Number (IMN)
... active ?!Ξ£ 0..1 boolean Whether this patient's record is in active use
... name SΞ£ 1..* HumanName A name associated with 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
.... use ?!Ξ£ 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Ξ£ 0..1 string Family name (often called 'Surname')
.... given SΞ£ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Ξ£ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Ξ£ 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 Ξ£ 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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)
.... 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 male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΞ£ 0..1 date The date of birth for the individual
... deceased[x] ?!Ξ£ 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΞ£ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Ξ£ 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Ξ£ 0..1 code postal | physical | both
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Ξ£ 0..* 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
Example General: 51 Bracken Rd
.... city SΞ£ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... district Ξ£ 0..1 string District name (aka county)
Example General: Madison
.... state SΞ£ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΞ£ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... country Ξ£ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Ξ£ 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗜𝗘𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 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
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Ξ£ 0..1 Reference(Organization) 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
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://iehr.ai/fhir/ie/core/ValueSet/simple-language
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-pat-01errorPatientAt least one patient identifier shall be valid, or if not available, the Data Absent Reason extension shall be present
: (identifier.where(system.count() + value.count() >1)).exists() xor identifier.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ie-core-pat-02errorPatientAt least one patient name shall have a family name, or if not available, the Data Absent Reason extension shall be present
: name.family.exists() xor name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • See the Scopes Format section for a description of the SMART scopes syntax.
  • See the Search Syntax section for a description of the IE Core search syntax.
  • See the General Requirements section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

IE Core Scopes

Servers providing access to patient data SHALL support these IE Core SMART Scopes:

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support bothΒ read Patient by id AND Patient search using the _id search parameter:

    GET [base]/Patient/[id] or GET [base]/Patient?_id=[id]

    Example:

    1. GET [base]/Patient/1032702
    2. GET [base]/Patient?_id=1032702

    Implementation Notes: (how to search by the logical id of the resource)

  2. SHALL support searching a patient by an identifier such as a MPI using the identifier search parameter:

    GET [base]/Patient?identifier={system|}[code]

    Example:

    1. GET [base]/Patient?identifier=http://hospital.smarthealthit.org|1032702

    Implementation Notes: Fetches a bundle containing any Patient resources matching the identifier (how to search by token)

  3. SHALL support searching for a patient by a server defined search that matches any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text using the name search parameter:

    GET [base]/Patient?name=[string]

    Example:

    1. GET [base]/Patient?name=Shaw

    Implementation Notes: Fetches a bundle of all Patient resources matching the name (how to search by string)

  4. SHALL support searching using the combination of the birthdate and name search parameters:

    GET [base]/Patient?birthdate=[date]&name=[string]

    Example:

    1. GET [base]/Patient?name=Shaw&birthdate=2007-03-20

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and name (how to search by date and how to search by string)

  5. SHALL support searching using the combination of the gender and name search parameters:

    GET [base]/Patient?gender={system|}[code]&name=[string]

    Example:

    1. GET [base]/Patient?name=Shaw&gender=female

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified gender and name (how to search by string and how to search by token)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the birthdate and family search parameters:

    GET [base]/Patient?birthdate=[date]&family=[string]

    Example:

    1. GET [base]/Patient?family=Shaw&birthdate=2007-03-20

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified birthdate and family (how to search by date and how to search by string)

  2. SHOULD support searching using the combination of the death-date and family search parameters:

    GET [base]/Patient?death-date=[date]&family=[string]

    Example:

    1. GET [base]/Patient?family=Shaw&death-date=2022-07-22

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified death-date and family (how to search by date and how to search by string)

  3. SHOULD support searching using the combination of the family and gender search parameters:

    GET [base]/Patient?family=[string]&gender={system|}[code]

    Example:

    1. GET [base]/Patient?family=Shaw&gender=female

    Implementation Notes: Fetches a bundle of all Patient resources matching the specified family and gender (how to search by string and how to search by token)