PH eReferral Implementation Guide
0.1.0 - ci-build Philippines flag

PH eReferral Implementation Guide, published by SILab CoP IG Accelerator (eReferral). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jldalisay95/ph-ereferral-jld/ and changes regularly. See the Directory of published versions

Resource Profile: ERefPatient - Detailed Descriptions

Draft as of 2026-04-29

Definitions for the ereferral-patient resource profile

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

0. Patient
Definition

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

ShortInformation about an individual or animal receiving health care services
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesSubjectOfCare Client Resident
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Patient.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Patient.extension:nationality
Slice Namenationality
Definition

The nationality of the patient.

ShortNationality
Control0..*
TypeExtension(Patient Nationality) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Patient.extension:religion
Slice Namereligion
Definition

The patient's professed religious affiliations.

ShortThe patient's professed religious affiliations
Control0..*
TypeExtension(Patient Religion) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Patient.extension:genderIdentity
Slice NamegenderIdentity
Definition

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

ShortGender Identity - in compliance with SOGIE Bill
Comments

This represents an individual’s identity, ascertained by asking them what that identity is.

Control0..*
TypeExtension(Individual Gender Identity) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Patient.extension:indigenousGroup
Slice NameindigenousGroup
Definition

Indigenous / ethnic group that the patient belongs to.

ShortIndigenous Group
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Indigenous Group) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Patient.extension:indigenousPeople
Slice NameindigenousPeople
Definition

If the patient is a member of an indigenous group.

ShortIndigenous People
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Indigenous People) (Extension Type: boolean)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Patient.extension:occupation
Slice Nameoccupation
Definition

Patient's occupation.

ShortOccupation
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Occupation) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Patient.extension:race
Slice Namerace
Definition

race of a patient.

ShortRace
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Race) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Patient.extension:educationalAttainment
Slice NameeducationalAttainment
Definition

Highest educational attainment of the patient.

ShortEducational Attainment
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Educational Attainment) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Patient.extension:sex
Slice Namesex
Definition

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

ShortSex assigned at birth - in compliance with SOGIE Bill
Control0..*
TypeExtension(Person Recorded Sex Or Gender) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Patient.extension:pwdDisability
Slice NamepwdDisability
Definition

Extension for Person With Disability (PWD) registration information. Captures PWD ID number, type of disability, and ID expiration date as issued by the PDAO (Persons with Disability Affairs Office).

ShortPH Core PWD Disability Registration
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(PH Core PWD Disability Registration) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Patient.extension:disabilityRegistration
Slice NamedisabilityRegistration
Definition

Person With Disability (PWD) registration information including PWD ID number, type of disability, and ID expiration date. (REF-30)

ShortPWD Registration Information
Control0..1
TypeExtension(PWD Disability Registration) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Patient.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

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

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. Patient.identifier
Definition

An identifier for this patient.

ShortAn identifier for this patient
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Requirements

Patients are almost always assigned specific numerical identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 30. Patient.identifier:PHCorePhilHealthID
    Slice NamePHCorePhilHealthID
    Definition

    An identifier for this patient.

    ShortAn identifier for this patient
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier(PIN - PhilHealth Identification Number)
    Is Modifierfalse
    Must Supporttrue
    Obligations
      ObligationsActorSource
      SHALL:handlePH Core Serverfrom PH Core Patient
      SHALL:handlePH Core Consumerfrom PH Core Patient
      MAY:able-to-populatePH Core Creatorfrom PH Core Patient
      Summarytrue
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Patient.identifier:PHCorePhilSysID
      Slice NamePHCorePhilSysID
      Definition

      An identifier for this patient.

      ShortAn identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier(PhilSys Identification Number (PhilSys ID))
      Is Modifierfalse
      Must Supporttrue
      Obligations
        ObligationsActorSource
        SHALL:handlePH Core Serverfrom PH Core Patient
        SHALL:handlePH Core Consumerfrom PH Core Patient
        MAY:able-to-populatePH Core Creatorfrom PH Core Patient
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Patient.active
        Definition

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

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

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

        ShortWhether this patient's record is in active use
        Comments

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

        Control0..1
        Typeboolean
        Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Patient.name
        Definition

        A name associated with the individual.

        ShortA name associated with the patient
        Comments

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

        Control10..*
        TypeHumanName(PH Core Name)
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActorSource
          SHALL:handlePH Core Serverfrom PH Core Patient
          SHALL:handlePH Core Consumerfrom PH Core Patient
          MAY:able-to-populatePH Core Creatorfrom PH Core Patient
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. Patient.telecom
          Definition

          Patient's contact information including phone numbers and email addresses. (REF-28)


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

          ShortContact NumberA contact detail for the individual
          Comments

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

          Control0..*
          TypeContactPoint
          Is Modifierfalse
          Must Supporttrue
          Obligations
            ObligationsActorSource
            SHALL:handlePH Core Serverfrom PH Core Patient
            SHALL:handlePH Core Consumerfrom PH Core Patient
            MAY:able-to-populatePH Core Creatorfrom PH Core Patient
            Summarytrue
            Requirements

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

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. Patient.telecom.system
            Definition

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

            Shortphone | fax | email | pager | url | sms | other
            Control0..1
            This element is affected by the following invariants: cpt-2
            BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
            (required to http://hl7.org/fhir/ValueSet/contact-point-system)
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. Patient.telecom.use
            Definition

            Identifies the purpose for the contact point.

            Shorthome | work | temp | old | mobile - purpose of this contact point
            Comments

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

            Control0..1
            BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
            (required to http://hl7.org/fhir/ValueSet/contact-point-use)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

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

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. Patient.gender
            Definition

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

            ShortAdministrative Gender - for backward compatibility with existing implementationsmale | female | other | unknown
            Comments

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

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

            The gender of a person used for administrative purposes.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Obligations
              ObligationsActorSource
              SHALL:handlePH Core Serverfrom PH Core Patient
              SHALL:handlePH Core Consumerfrom PH Core Patient
              MAY:able-to-populatePH Core Creatorfrom PH Core Patient
              Summarytrue
              Requirements

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              46. Patient.birthDate
              Definition

              The date of birth for the individual.

              ShortThe date of birth for the individual
              Comments

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

              Control10..1
              Typedate
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Obligations
                ObligationsActorSource
                SHALL:handlePH Core Serverfrom PH Core Patient
                SHALL:handlePH Core Consumerfrom PH Core Patient
                MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                Summarytrue
                Requirements

                Age of the individual drives many clinical processes.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                LOINC Code21112-8
                48. Patient.deceased[x]
                Definition

                Indicates if the individual is deceased or not.

                ShortIndicates if the individual is deceased or not
                Comments

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

                Control0..1
                TypeChoice of: boolean, dateTime
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                50. Patient.address
                Definition

                Current residence address of the patient. Use PHCoreAddress extensions for PSGC-coded barangay, city/municipality, and province. (REF-27)


                An address for the individual.

                ShortPatient AddressAn address for the individual
                Comments

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

                Control0..*
                TypeAddress(PH Core Address)
                Is Modifierfalse
                Must Supporttrue
                Obligations
                  ObligationsActorSource
                  SHALL:handlePH Core Serverfrom PH Core Patient
                  SHALL:handlePH Core Consumerfrom PH Core Patient
                  MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                  Summarytrue
                  Requirements

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

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. Patient.maritalStatus
                  Definition

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

                  ShortMarital (civil) status of a patient
                  Control0..1
                  BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status|4.0.1
                  (required to http://hl7.org/fhir/ValueSet/marital-status)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Obligations
                    ObligationsActorSource
                    SHALL:handlePH Core Serverfrom PH Core Patient
                    SHALL:handlePH Core Consumerfrom PH Core Patient
                    MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                    Summaryfalse
                    Requirements

                    Most, if not all systems capture it.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    54. Patient.maritalStatus.coding
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortCode defined by a terminology system
                    Comments

                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                    Control0..*
                    TypeCoding
                    Is Modifierfalse
                    Must Supporttrue
                    Obligations
                      ObligationsActorSource
                      SHALL:handlePH Core Serverfrom PH Core Patient
                      SHALL:handlePH Core Consumerfrom PH Core Patient
                      MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                      Summarytrue
                      Requirements

                      Allows for alternative encodings within a code system, and translations to other code systems.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      56. Patient.maritalStatus.text
                      Definition

                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                      ShortPlain text representation of the concept
                      Comments

                      Very often the text is the same as a displayName of one of the codings.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Obligations
                        ObligationsActorSource
                        SHALL:handlePH Core Serverfrom PH Core Patient
                        SHALL:handlePH Core Consumerfrom PH Core Patient
                        MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                        Summarytrue
                        Requirements

                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        58. Patient.contact
                        Definition

                        Contact details for the patient's companion, guardian, or next of kin who may be contacted regarding the referral. (REF-29)


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

                        ShortAccompanied By / Next of KinA contact party (e.g. guardian, partner, friend) for the patient
                        Comments

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

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Requirements

                        Need to track people you can contact about the patient.

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

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

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

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

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

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

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

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        62. Patient.contact.relationship
                        Definition

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

                        ShortThe kind of relationship
                        Control10..*
                        BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1
                        (required to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype)
                        TypeCodeableConcept
                        Is Modifierfalse
                        Must Supporttrue
                        Obligations
                          ObligationsActorSource
                          SHALL:handlePH Core Serverfrom PH Core Patient
                          SHALL:handlePH Core Consumerfrom PH Core Patient
                          MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                          Summaryfalse
                          Requirements

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

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          64. Patient.contact.relationship.coding
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                          Control0..*
                          TypeCoding
                          Is Modifierfalse
                          Must Supporttrue
                          Obligations
                            ObligationsActorSource
                            SHALL:handlePH Core Serverfrom PH Core Patient
                            SHALL:handlePH Core Consumerfrom PH Core Patient
                            MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                            Summarytrue
                            Requirements

                            Allows for alternative encodings within a code system, and translations to other code systems.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            66. Patient.contact.relationship.text
                            Definition

                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                            ShortPlain text representation of the concept
                            Comments

                            Very often the text is the same as a displayName of one of the codings.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Obligations
                              ObligationsActorSource
                              SHALL:handlePH Core Serverfrom PH Core Patient
                              SHALL:handlePH Core Consumerfrom PH Core Patient
                              MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                              Summarytrue
                              Requirements

                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              68. Patient.contact.name
                              Definition

                              A name associated with the contact person.

                              ShortA name associated with the contact person
                              Control10..1
                              TypeHumanName(PH Core Name)
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Requirements

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              70. Patient.contact.telecom
                              Definition

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

                              ShortA contact detail for the person
                              Comments

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

                              Control0..*
                              TypeContactPoint
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Requirements

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              72. Patient.contact.address
                              Definition

                              Address for the contact person.

                              ShortAddress for the contact person
                              Control0..1
                              TypeAddress(PH Core Address)
                              Is Modifierfalse
                              Must Supporttrue
                              Obligations
                                ObligationsActorSource
                                SHALL:handlePH Core Serverfrom PH Core Patient
                                SHALL:handlePH Core Consumerfrom PH Core Patient
                                MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                Summaryfalse
                                Requirements

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                74. Patient.communication
                                Definition

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

                                ShortA language which may be used to communicate with the patient about his or her health
                                Comments

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

                                Control0..*
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Requirements

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                76. Patient.communication.modifierExtension
                                Definition

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

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

                                ShortExtensions that cannot be ignored even if unrecognized
                                Comments

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

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

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

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                78. Patient.communication.language
                                Definition

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

                                ShortThe language which can be used to communicate with the patient about his or her health
                                Comments

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

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

                                A human language.

                                Additional BindingsPurpose
                                AllLanguagesMax Binding
                                TypeCodeableConcept
                                Is Modifierfalse
                                Must Supporttrue
                                Obligations
                                  ObligationsActorSource
                                  SHALL:handlePH Core Serverfrom PH Core Patient
                                  SHALL:handlePH Core Consumerfrom PH Core Patient
                                  MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                  Summaryfalse
                                  Requirements

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

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  80. Patient.communication.language.coding
                                  Definition

                                  A reference to a code defined by a terminology system.

                                  ShortCode defined by a terminology system
                                  Comments

                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                  Control0..*
                                  TypeCoding
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActorSource
                                    SHALL:handlePH Core Serverfrom PH Core Patient
                                    SHALL:handlePH Core Consumerfrom PH Core Patient
                                    MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                    Summarytrue
                                    Requirements

                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    82. Patient.communication.language.text
                                    Definition

                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                    ShortPlain text representation of the concept
                                    Comments

                                    Very often the text is the same as a displayName of one of the codings.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Obligations
                                      ObligationsActorSource
                                      SHALL:handlePH Core Serverfrom PH Core Patient
                                      SHALL:handlePH Core Consumerfrom PH Core Patient
                                      MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                      Summarytrue
                                      Requirements

                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      84. Patient.link
                                      Definition

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

                                      ShortLink to another patient resource that concerns the same actual person
                                      Comments

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

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

                                      There are multiple use cases:

                                      • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                      • Distribution of patient information across multiple servers.
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      86. Patient.link.modifierExtension
                                      Definition

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

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

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

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

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

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

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      88. Patient.link.other
                                      Definition

                                      The other patient resource that the link refers to.

                                      ShortThe other patient or related person resource that the link refers to
                                      Comments

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

                                      Control1..1
                                      TypeReference(PH Core Patient, PH Core RelatedPerson, Patient, RelatedPerson)
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      90. Patient.link.type
                                      Definition

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

                                      Shortreplaced-by | replaces | refer | seealso
                                      Control1..1
                                      BindingThe codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1
                                      (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

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

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                                      0. Patient
                                      2. Patient.extension:disabilityRegistration
                                      Slice NamedisabilityRegistration
                                      Definition

                                      Person With Disability (PWD) registration information including PWD ID number, type of disability, and ID expiration date. (REF-30)

                                      ShortPWD Registration Information
                                      Control0..1
                                      TypeExtension(PWD Disability Registration) (Complex Extension)
                                      Must Supporttrue
                                      4. Patient.name
                                      Control1..?
                                      6. Patient.telecom
                                      Definition

                                      Patient's contact information including phone numbers and email addresses. (REF-28)

                                      ShortContact Number
                                      8. Patient.telecom.system
                                      BindingThe codes SHALL be taken from ContactPointSystem
                                      (required to http://hl7.org/fhir/ValueSet/contact-point-system)
                                      10. Patient.telecom.use
                                      BindingThe codes SHALL be taken from ContactPointUse
                                      (required to http://hl7.org/fhir/ValueSet/contact-point-use)
                                      12. Patient.gender
                                      Control1..?
                                      14. Patient.birthDate
                                      Control1..?
                                      LOINC Code
                                      16. Patient.address
                                      Definition

                                      Current residence address of the patient. Use PHCoreAddress extensions for PSGC-coded barangay, city/municipality, and province. (REF-27)

                                      ShortPatient Address
                                      18. Patient.contact
                                      Definition

                                      Contact details for the patient's companion, guardian, or next of kin who may be contacted regarding the referral. (REF-29)

                                      ShortAccompanied By / Next of Kin
                                      20. Patient.contact.relationship
                                      Control1..?
                                      22. Patient.contact.name
                                      Control1..?
                                      Must Supporttrue
                                      24. Patient.contact.telecom
                                      Must Supporttrue

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

                                      0. Patient
                                      Definition

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

                                      ShortInformation about an individual or animal receiving health care services
                                      Control0..*
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate NamesSubjectOfCare Client Resident
                                      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                      dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                      dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                      2. Patient.id
                                      Definition

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

                                      ShortLogical id of this artifact
                                      Comments

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

                                      Control0..1
                                      Typeid
                                      Is Modifierfalse
                                      Summarytrue
                                      4. Patient.meta
                                      Definition

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

                                      ShortMetadata about the resource
                                      Control0..1
                                      TypeMeta
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      6. Patient.implicitRules
                                      Definition

                                      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                      ShortA set of rules under which this content was created
                                      Comments

                                      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                      Control0..1
                                      Typeuri
                                      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      8. Patient.language
                                      Definition

                                      The base language in which the resource is written.

                                      ShortLanguage of the resource content
                                      Comments

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

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

                                      A human language.

                                      Additional BindingsPurpose
                                      AllLanguagesMax Binding
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      10. Patient.text
                                      Definition

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

                                      ShortText summary of the resource, for human interpretation
                                      Comments

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

                                      Control0..1
                                      TypeNarrative
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesnarrative, html, xhtml, display
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      12. Patient.contained
                                      Definition

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

                                      ShortContained, inline Resources
                                      Comments

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

                                      Control0..*
                                      TypeResource
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesinline resources, anonymous resources, contained resources
                                      14. Patient.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 16. Patient.extension:nationality
                                        Slice Namenationality
                                        Definition

                                        The nationality of the patient.

                                        ShortNationality
                                        Control0..*
                                        TypeExtension(Patient Nationality) (Complex Extension)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        18. Patient.extension:religion
                                        Slice Namereligion
                                        Definition

                                        The patient's professed religious affiliations.

                                        ShortThe patient's professed religious affiliations
                                        Control0..*
                                        TypeExtension(Patient Religion) (Extension Type: CodeableConcept)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        20. Patient.extension:genderIdentity
                                        Slice NamegenderIdentity
                                        Definition

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

                                        ShortGender Identity - in compliance with SOGIE Bill
                                        Comments

                                        This represents an individual’s identity, ascertained by asking them what that identity is.

                                        Control0..*
                                        TypeExtension(Individual Gender Identity) (Complex Extension)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        22. Patient.extension:indigenousGroup
                                        Slice NameindigenousGroup
                                        Definition

                                        Indigenous / ethnic group that the patient belongs to.

                                        ShortIndigenous Group
                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Indigenous Group) (Extension Type: CodeableConcept)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        24. Patient.extension:indigenousPeople
                                        Slice NameindigenousPeople
                                        Definition

                                        If the patient is a member of an indigenous group.

                                        ShortIndigenous People
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Indigenous People) (Extension Type: boolean)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        26. Patient.extension:occupation
                                        Slice Nameoccupation
                                        Definition

                                        Patient's occupation.

                                        ShortOccupation
                                        Control0..*
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Occupation) (Complex Extension)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        28. Patient.extension:race
                                        Slice Namerace
                                        Definition

                                        race of a patient.

                                        ShortRace
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Race) (Extension Type: CodeableConcept)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        30. Patient.extension:educationalAttainment
                                        Slice NameeducationalAttainment
                                        Definition

                                        Highest educational attainment of the patient.

                                        ShortEducational Attainment
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(Educational Attainment) (Extension Type: CodeableConcept)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        32. Patient.extension:sex
                                        Slice Namesex
                                        Definition

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

                                        ShortSex assigned at birth - in compliance with SOGIE Bill
                                        Control0..*
                                        TypeExtension(Person Recorded Sex Or Gender) (Complex Extension)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        34. Patient.extension:pwdDisability
                                        Slice NamepwdDisability
                                        Definition

                                        Extension for Person With Disability (PWD) registration information. Captures PWD ID number, type of disability, and ID expiration date as issued by the PDAO (Persons with Disability Affairs Office).

                                        ShortPH Core PWD Disability Registration
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        TypeExtension(PH Core PWD Disability Registration) (Complex Extension)
                                        Is Modifierfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        36. Patient.extension:disabilityRegistration
                                        Slice NamedisabilityRegistration
                                        Definition

                                        Person With Disability (PWD) registration information including PWD ID number, type of disability, and ID expiration date. (REF-30)

                                        ShortPWD Registration Information
                                        Control0..1
                                        TypeExtension(PWD Disability Registration) (Complex Extension)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        38. Patient.modifierExtension
                                        Definition

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

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

                                        ShortExtensions that cannot be ignored
                                        Comments

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

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                        Summaryfalse
                                        Requirements

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

                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        40. Patient.identifier
                                        Definition

                                        An identifier for this patient.

                                        ShortAn identifier for this patient
                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..*
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        Patients are almost always assigned specific numerical identifiers.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ system
                                        • 42. Patient.identifier:PHCorePhilHealthID
                                          Slice NamePHCorePhilHealthID
                                          Definition

                                          An identifier for this patient.

                                          ShortAn identifier for this patient
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..*
                                          TypeIdentifier(PIN - PhilHealth Identification Number)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Obligations
                                            ObligationsActorSource
                                            SHALL:handlePH Core Serverfrom PH Core Patient
                                            SHALL:handlePH Core Consumerfrom PH Core Patient
                                            MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                            Summarytrue
                                            Requirements

                                            Patients are almost always assigned specific numerical identifiers.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            44. Patient.identifier:PHCorePhilSysID
                                            Slice NamePHCorePhilSysID
                                            Definition

                                            An identifier for this patient.

                                            ShortAn identifier for this patient
                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                            Control0..*
                                            TypeIdentifier(PhilSys Identification Number (PhilSys ID))
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActorSource
                                              SHALL:handlePH Core Serverfrom PH Core Patient
                                              SHALL:handlePH Core Consumerfrom PH Core Patient
                                              MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                              Summarytrue
                                              Requirements

                                              Patients are almost always assigned specific numerical identifiers.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              46. Patient.active
                                              Definition

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

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

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

                                              ShortWhether this patient's record is in active use
                                              Comments

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

                                              Control0..1
                                              Typeboolean
                                              Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

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

                                              Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              48. Patient.name
                                              Definition

                                              A name associated with the individual.

                                              ShortA name associated with the patient
                                              Comments

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

                                              Control1..*
                                              TypeHumanName(PH Core Name)
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Obligations
                                                ObligationsActorSource
                                                SHALL:handlePH Core Serverfrom PH Core Patient
                                                SHALL:handlePH Core Consumerfrom PH Core Patient
                                                MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                Summarytrue
                                                Requirements

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

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                50. Patient.telecom
                                                Definition

                                                Patient's contact information including phone numbers and email addresses. (REF-28)

                                                ShortContact Number
                                                Comments

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

                                                Control0..*
                                                TypeContactPoint
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Obligations
                                                  ObligationsActorSource
                                                  SHALL:handlePH Core Serverfrom PH Core Patient
                                                  SHALL:handlePH Core Consumerfrom PH Core Patient
                                                  MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                  Summarytrue
                                                  Requirements

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

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  52. Patient.telecom.id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  54. Patient.telecom.extension
                                                  Definition

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

                                                  ShortAdditional content defined by implementations
                                                  Comments

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 56. Patient.telecom.system
                                                    Definition

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

                                                    Shortphone | fax | email | pager | url | sms | other
                                                    Control0..1
                                                    This element is affected by the following invariants: cpt-2
                                                    BindingThe codes SHALL be taken from ContactPointSystem
                                                    (required to http://hl7.org/fhir/ValueSet/contact-point-system)
                                                    Typecode
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    58. Patient.telecom.value
                                                    Definition

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

                                                    ShortThe actual contact point details
                                                    Comments

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

                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

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

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    60. Patient.telecom.use
                                                    Definition

                                                    Identifies the purpose for the contact point.

                                                    Shorthome | work | temp | old | mobile - purpose of this contact point
                                                    Comments

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

                                                    Control0..1
                                                    BindingThe codes SHALL be taken from ContactPointUse
                                                    (required to http://hl7.org/fhir/ValueSet/contact-point-use)
                                                    Typecode
                                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

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

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    62. Patient.telecom.rank
                                                    Definition

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

                                                    ShortSpecify preferred order of use (1 = highest)
                                                    Comments

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

                                                    Control0..1
                                                    TypepositiveInt
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    64. Patient.telecom.period
                                                    Definition

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

                                                    ShortTime period when the contact point was/is in use
                                                    Control0..1
                                                    TypePeriod
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    66. Patient.gender
                                                    Definition

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

                                                    ShortAdministrative Gender - for backward compatibility with existing implementations
                                                    Comments

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

                                                    Control1..1
                                                    BindingThe codes SHALL be taken from AdministrativeGender
                                                    (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                    The gender of a person used for administrative purposes.

                                                    Typecode
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Obligations
                                                      ObligationsActorSource
                                                      SHALL:handlePH Core Serverfrom PH Core Patient
                                                      SHALL:handlePH Core Consumerfrom PH Core Patient
                                                      MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                      Summarytrue
                                                      Requirements

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

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      68. Patient.birthDate
                                                      Definition

                                                      The date of birth for the individual.

                                                      ShortThe date of birth for the individual
                                                      Comments

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

                                                      Control1..1
                                                      Typedate
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Obligations
                                                        ObligationsActorSource
                                                        SHALL:handlePH Core Serverfrom PH Core Patient
                                                        SHALL:handlePH Core Consumerfrom PH Core Patient
                                                        MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                        Summarytrue
                                                        Requirements

                                                        Age of the individual drives many clinical processes.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        LOINC Code21112-8
                                                        70. Patient.deceased[x]
                                                        Definition

                                                        Indicates if the individual is deceased or not.

                                                        ShortIndicates if the individual is deceased or not
                                                        Comments

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

                                                        Control0..1
                                                        TypeChoice of: boolean, dateTime
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Requirements

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

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        72. Patient.address
                                                        Definition

                                                        Current residence address of the patient. Use PHCoreAddress extensions for PSGC-coded barangay, city/municipality, and province. (REF-27)

                                                        ShortPatient Address
                                                        Comments

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

                                                        Control0..*
                                                        TypeAddress(PH Core Address)
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Obligations
                                                          ObligationsActorSource
                                                          SHALL:handlePH Core Serverfrom PH Core Patient
                                                          SHALL:handlePH Core Consumerfrom PH Core Patient
                                                          MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                          Summarytrue
                                                          Requirements

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

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          74. Patient.maritalStatus
                                                          Definition

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

                                                          ShortMarital (civil) status of a patient
                                                          Control0..1
                                                          BindingThe codes SHALL be taken from Marital Status Codes
                                                          (required to http://hl7.org/fhir/ValueSet/marital-status)
                                                          TypeCodeableConcept
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Obligations
                                                            ObligationsActorSource
                                                            SHALL:handlePH Core Serverfrom PH Core Patient
                                                            SHALL:handlePH Core Consumerfrom PH Core Patient
                                                            MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                            Summaryfalse
                                                            Requirements

                                                            Most, if not all systems capture it.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            76. Patient.maritalStatus.id
                                                            Definition

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

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            78. Patient.maritalStatus.extension
                                                            Definition

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

                                                            ShortAdditional content defined by implementations
                                                            Comments

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

                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            SlicingThis element introduces a set of slices on Patient.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 80. Patient.maritalStatus.coding
                                                              Definition

                                                              A reference to a code defined by a terminology system.

                                                              ShortCode defined by a terminology system
                                                              Comments

                                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                              Control0..*
                                                              TypeCoding
                                                              Is Modifierfalse
                                                              Must Supporttrue
                                                              Obligations
                                                                ObligationsActorSource
                                                                SHALL:handlePH Core Serverfrom PH Core Patient
                                                                SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                Summarytrue
                                                                Requirements

                                                                Allows for alternative encodings within a code system, and translations to other code systems.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                82. Patient.maritalStatus.text
                                                                Definition

                                                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                ShortPlain text representation of the concept
                                                                Comments

                                                                Very often the text is the same as a displayName of one of the codings.

                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supporttrue
                                                                Obligations
                                                                  ObligationsActorSource
                                                                  SHALL:handlePH Core Serverfrom PH Core Patient
                                                                  SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                  MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                  Summarytrue
                                                                  Requirements

                                                                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  84. Patient.multipleBirth[x]
                                                                  Definition

                                                                  Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                  ShortWhether patient is part of a multiple birth
                                                                  Comments

                                                                  Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                  Control0..1
                                                                  TypeChoice of: boolean, integer
                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summaryfalse
                                                                  Requirements

                                                                  For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  86. Patient.photo
                                                                  Definition

                                                                  Image of the patient.

                                                                  ShortImage of the patient
                                                                  Comments

                                                                  Guidelines:

                                                                  • Use id photos, not clinical photos.
                                                                  • Limit dimensions to thumbnail.
                                                                  • Keep byte count low to ease resource updates.
                                                                  Control0..*
                                                                  TypeAttachment
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  88. Patient.contact
                                                                  Definition

                                                                  Contact details for the patient's companion, guardian, or next of kin who may be contacted regarding the referral. (REF-29)

                                                                  ShortAccompanied By / Next of Kin
                                                                  Comments

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

                                                                  Control0..*
                                                                  TypeBackboneElement
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Need to track people you can contact about the patient.

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

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

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  92. Patient.contact.extension
                                                                  Definition

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

                                                                  ShortAdditional content defined by implementations
                                                                  Comments

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

                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  94. Patient.contact.modifierExtension
                                                                  Definition

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

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

                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                  Comments

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

                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                  Summarytrue
                                                                  Requirements

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

                                                                  Alternate Namesextensions, user content, modifiers
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  96. Patient.contact.relationship
                                                                  Definition

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

                                                                  ShortThe kind of relationship
                                                                  Control1..*
                                                                  BindingThe codes SHALL be taken from PatientRelationshipType
                                                                  (required to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype)
                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Obligations
                                                                    ObligationsActorSource
                                                                    SHALL:handlePH Core Serverfrom PH Core Patient
                                                                    SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                    MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                    Summaryfalse
                                                                    Requirements

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

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    98. Patient.contact.relationship.id
                                                                    Definition

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    100. Patient.contact.relationship.extension
                                                                    Definition

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

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

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

                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Alternate Namesextensions, user content
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    SlicingThis element introduces a set of slices on Patient.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 102. Patient.contact.relationship.coding
                                                                      Definition

                                                                      A reference to a code defined by a terminology system.

                                                                      ShortCode defined by a terminology system
                                                                      Comments

                                                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                      Control0..*
                                                                      TypeCoding
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Obligations
                                                                        ObligationsActorSource
                                                                        SHALL:handlePH Core Serverfrom PH Core Patient
                                                                        SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                        MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                        Summarytrue
                                                                        Requirements

                                                                        Allows for alternative encodings within a code system, and translations to other code systems.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        104. Patient.contact.relationship.text
                                                                        Definition

                                                                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                        ShortPlain text representation of the concept
                                                                        Comments

                                                                        Very often the text is the same as a displayName of one of the codings.

                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supporttrue
                                                                        Obligations
                                                                          ObligationsActorSource
                                                                          SHALL:handlePH Core Serverfrom PH Core Patient
                                                                          SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                          MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                          Summarytrue
                                                                          Requirements

                                                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          106. Patient.contact.name
                                                                          Definition

                                                                          A name associated with the contact person.

                                                                          ShortA name associated with the contact person
                                                                          Control1..1
                                                                          TypeHumanName(PH Core Name)
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Requirements

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

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          108. Patient.contact.telecom
                                                                          Definition

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

                                                                          ShortA contact detail for the person
                                                                          Comments

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

                                                                          Control0..*
                                                                          TypeContactPoint
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Requirements

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

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          110. Patient.contact.address
                                                                          Definition

                                                                          Address for the contact person.

                                                                          ShortAddress for the contact person
                                                                          Control0..1
                                                                          TypeAddress(PH Core Address)
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Obligations
                                                                            ObligationsActorSource
                                                                            SHALL:handlePH Core Serverfrom PH Core Patient
                                                                            SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                            MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                            Summaryfalse
                                                                            Requirements

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

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            112. Patient.contact.gender
                                                                            Definition

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

                                                                            Shortmale | female | other | unknown
                                                                            Control0..1
                                                                            BindingThe codes SHALL be taken from AdministrativeGender
                                                                            (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                            The gender of a person used for administrative purposes.

                                                                            Typecode
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summaryfalse
                                                                            Requirements

                                                                            Needed to address the person correctly.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            114. Patient.contact.organization
                                                                            Definition

                                                                            Organization on behalf of which the contact is acting or for which the contact is working.

                                                                            ShortOrganization that is associated with the contact
                                                                            Control0..1
                                                                            This element is affected by the following invariants: pat-1
                                                                            TypeReference(PH Core Organization)
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Requirements

                                                                            For guardians or business related contacts, the organization is relevant.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            116. Patient.contact.period
                                                                            Definition

                                                                            The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                            ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                            Control0..1
                                                                            TypePeriod
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            118. Patient.communication
                                                                            Definition

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

                                                                            ShortA language which may be used to communicate with the patient about his or her health
                                                                            Comments

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

                                                                            Control0..*
                                                                            TypeBackboneElement
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Requirements

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

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            120. Patient.communication.id
                                                                            Definition

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

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            122. Patient.communication.extension
                                                                            Definition

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

                                                                            ShortAdditional content defined by implementations
                                                                            Comments

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

                                                                            Control0..*
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Alternate Namesextensions, user content
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            124. Patient.communication.modifierExtension
                                                                            Definition

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

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

                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                            Comments

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

                                                                            Control0..*
                                                                            TypeExtension
                                                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                            Summarytrue
                                                                            Requirements

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

                                                                            Alternate Namesextensions, user content, modifiers
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            126. Patient.communication.language
                                                                            Definition

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

                                                                            ShortThe language which can be used to communicate with the patient about his or her health
                                                                            Comments

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

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

                                                                            A human language.

                                                                            Additional BindingsPurpose
                                                                            AllLanguagesMax Binding
                                                                            TypeCodeableConcept
                                                                            Is Modifierfalse
                                                                            Must Supporttrue
                                                                            Obligations
                                                                              ObligationsActorSource
                                                                              SHALL:handlePH Core Serverfrom PH Core Patient
                                                                              SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                              MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                              Summaryfalse
                                                                              Requirements

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              128. Patient.communication.language.id
                                                                              Definition

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

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              130. Patient.communication.language.extension
                                                                              Definition

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

                                                                              ShortAdditional content defined by implementations
                                                                              Comments

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

                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              SlicingThis element introduces a set of slices on Patient.communication.language.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 132. Patient.communication.language.coding
                                                                                Definition

                                                                                A reference to a code defined by a terminology system.

                                                                                ShortCode defined by a terminology system
                                                                                Comments

                                                                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                Control0..*
                                                                                TypeCoding
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Obligations
                                                                                  ObligationsActorSource
                                                                                  SHALL:handlePH Core Serverfrom PH Core Patient
                                                                                  SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                                  MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  134. Patient.communication.language.text
                                                                                  Definition

                                                                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                  ShortPlain text representation of the concept
                                                                                  Comments

                                                                                  Very often the text is the same as a displayName of one of the codings.

                                                                                  Control0..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Must Supporttrue
                                                                                  Obligations
                                                                                    ObligationsActorSource
                                                                                    SHALL:handlePH Core Serverfrom PH Core Patient
                                                                                    SHALL:handlePH Core Consumerfrom PH Core Patient
                                                                                    MAY:able-to-populatePH Core Creatorfrom PH Core Patient
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    136. Patient.communication.preferred
                                                                                    Definition

                                                                                    Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                                    ShortLanguage preference indicator
                                                                                    Comments

                                                                                    This language is specifically identified for communicating healthcare information.

                                                                                    Control0..1
                                                                                    Typeboolean
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summaryfalse
                                                                                    Requirements

                                                                                    People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    138. Patient.generalPractitioner
                                                                                    Definition

                                                                                    Patient's nominated care provider.

                                                                                    ShortPatient's nominated primary care provider
                                                                                    Comments

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

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

                                                                                    Control0..*
                                                                                    TypeReference(PH Core Practitioner, PH Core PractitionerRole, PH Core Organization)
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Alternate NamescareProvider
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    140. Patient.managingOrganization
                                                                                    Definition

                                                                                    Organization that is the custodian of the patient record.

                                                                                    ShortOrganization that is the custodian of the patient record
                                                                                    Comments

                                                                                    There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                    Control0..1
                                                                                    TypeReference(PH Core Organization)
                                                                                    Is Modifierfalse
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    Need to know who recognizes this patient record, manages and updates it.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    142. Patient.link
                                                                                    Definition

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

                                                                                    ShortLink to another patient resource that concerns the same actual person
                                                                                    Comments

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

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

                                                                                    There are multiple use cases:

                                                                                    • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                    • Distribution of patient information across multiple servers.
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    144. Patient.link.id
                                                                                    Definition

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

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    146. Patient.link.extension
                                                                                    Definition

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

                                                                                    ShortAdditional content defined by implementations
                                                                                    Comments

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

                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Alternate Namesextensions, user content
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    148. Patient.link.modifierExtension
                                                                                    Definition

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

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

                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                    Comments

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

                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                    Summarytrue
                                                                                    Requirements

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

                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    150. Patient.link.other
                                                                                    Definition

                                                                                    The other patient resource that the link refers to.

                                                                                    ShortThe other patient or related person resource that the link refers to
                                                                                    Comments

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

                                                                                    Control1..1
                                                                                    TypeReference(PH Core Patient, PH Core RelatedPerson)
                                                                                    Is Modifierfalse
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    152. Patient.link.type
                                                                                    Definition

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

                                                                                    Shortreplaced-by | replaces | refer | seealso
                                                                                    Control1..1
                                                                                    BindingThe codes SHALL be taken from LinkType
                                                                                    (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

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

                                                                                    Typecode
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))