Work in progress.
This section of the Implementation Guide is subject to change.

Profile EEBaseRelatedPerson


Profile Purpose

This profile builds on RelatedPerson resource. The profile allows information exchange about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Example usage scenarios

  • Query for relationship between patient and related person using the query parameter RelatedPerson.relationship
  • Query for communication language of the RelatedPerson with query parameter RelatedPerson.communication.language
  • Exchange RelatedPerson information within a FHIR document or message


Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
est-idS Σ0..1EEBase Estonian Personal Identification Number
tis-idΣ0..1EEBase TIS ID
activeΣ ?!0..1boolean
patientS Σ I1..1Reference(EEBase Patient)
relationshipS Σ0..*CodeableConceptBinding
nameΣ0..*HumanName
telecomS Σ I0..*ContactPoint
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*EEBase Address
photoI0..*Attachment
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
est-idS Σ0..1EEBase Estonian Personal Identification Number
tis-idΣ0..1EEBase TIS ID
activeΣ ?!0..1boolean
patientS Σ I1..1Reference(EEBase Patient)
relationshipS Σ0..*CodeableConceptBinding
nameΣ0..*HumanName
telecomS Σ I0..*ContactPoint
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*EEBase Address
photoI0..*Attachment
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
est-idS Σ0..1EEBase Estonian Personal Identification Number
tis-idΣ0..1EEBase TIS ID
activeΣ ?!0..1boolean
patientS Σ I1..1Reference(EEBase Patient)
relationshipS Σ0..*CodeableConceptBinding
nameΣ0..*HumanName
telecomS Σ I0..*ContactPoint
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*EEBase Address
photoI0..*Attachment
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean

Table View

RelatedPerson..
RelatedPerson.identifier..
RelatedPerson.identifierEEBase Estonian Personal Identification Number..1
RelatedPerson.identifierEEBase TIS ID..1
RelatedPerson.patientReference(EEBase Patient)..
RelatedPerson.relationship..
RelatedPerson.telecom..
RelatedPerson.addressEEBase Address..
RelatedPerson.communication..
RelatedPerson.communication.language..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="EEBase-RelatedPerson" />
    <url value="https://hl7.ee/fhir/StructureDefinition/EEBase-RelatedPerson" />
    <version value="1.0.0" />
    <name value="EEBaseRelatedPerson" />
    <title value="EEBase RelatedPerson" />
    <status value="draft" />
    <date value="2022-11-21T13:22:24.2179018+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="RelatedPerson" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
    <derivation value="constraint" />
    <differential>
        <element id="RelatedPerson.identifier">
            <path value="RelatedPerson.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="RelatedPerson.identifier:est-id">
            <path value="RelatedPerson.identifier" />
            <sliceName value="est-id" />
            <short value="Estonian personal identification" />
            <definition value="Eesti isikukoodi identifikaator" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-ESTID" />
            </type>
        </element>
        <element id="RelatedPerson.identifier:tis-id">
            <path value="RelatedPerson.identifier" />
            <sliceName value="tis-id" />
            <short value="Person&#39;s unique code generated by National Health System" />
            <definition value="Isiku unikaalne tunnus, mille alusel saab teda eristada teistest isikutest TIS-is. Saab kasutada nii v&#228;limaalaste kui ka tundmatu isiku jaoks (juhtudel, kui puudub Eesti isikukood). M&#245;eldud andmevahetuseks Tervise infos&#252;steemiga." />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-TISID" />
            </type>
        </element>
        <element id="RelatedPerson.patient">
            <path value="RelatedPerson.patient" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Patient" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.relationship">
            <path value="RelatedPerson.relationship" />
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.telecom">
            <path value="RelatedPerson.telecom" />
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.address">
            <path value="RelatedPerson.address" />
            <type>
                <code value="Address" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Address" />
            </type>
        </element>
        <element id="RelatedPerson.communication.language">
            <path value="RelatedPerson.communication.language" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
                    <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="Language" />
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
                    <valueBoolean value="true" />
                </extension>
                <strength value="preferred" />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "EEBase-RelatedPerson",
    "url": "https://hl7.ee/fhir/StructureDefinition/EEBase-RelatedPerson",
    "version": "1.0.0",
    "name": "EEBaseRelatedPerson",
    "title": "EEBase RelatedPerson",
    "status": "draft",
    "date": "2022-11-21T13:22:24.2179018+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "RelatedPerson",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "RelatedPerson.identifier",
                "path": "RelatedPerson.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "RelatedPerson.identifier:est-id",
                "path": "RelatedPerson.identifier",
                "sliceName": "est-id",
                "short": "Estonian personal identification",
                "definition": "Eesti isikukoodi identifikaator",
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-ESTID"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.identifier:tis-id",
                "path": "RelatedPerson.identifier",
                "sliceName": "tis-id",
                "short": "Person's unique code generated by National Health System",
                "definition": "Isiku unikaalne tunnus, mille alusel saab teda eristada teistest isikutest TIS-is. Saab kasutada nii välimaalaste kui ka tundmatu isiku jaoks (juhtudel, kui puudub Eesti isikukood). Mõeldud andmevahetuseks Tervise infosüsteemiga.",
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-TISID"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.patient",
                "path": "RelatedPerson.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.relationship",
                "path": "RelatedPerson.relationship",
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.telecom",
                "path": "RelatedPerson.telecom",
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.address",
                "path": "RelatedPerson.address",
                "type":  [
                    {
                        "code": "Address",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Address"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.communication.language",
                "path": "RelatedPerson.communication.language",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
                            "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "Language"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
                            "valueBoolean": true
                        }
                    ],
                    "strength": "preferred",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
                }
            }
        ]
    }
}


identifier

Identifier for a person who is related to the patient. It is recommended that the identifier value is Estonian Personal Identification Number. In case related person does not have Estonian Personal Identification Number then TIS Personal Identification Number is used.


active

This is a mandatory data element.

Whether this practitioner role record is in active use.


patient (Must support)

This is a mandatory data element.

The patient this person is related to as a reference to EEBase Patient.


relationship (Must support)

This ValueSet EEBaseRelatedpersonRelationship is currently under development.

Coded value of the nature of the relationship between the patient and related person. The required ValueSet used in this case is EEBaseRelatedpersonRelationship, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

name

A name associated with the related person.


telecom (Must support)

A contact detail(s) (e.g. phone number and/or an email address) by which the related person may be contacted.


gender

The gender that the person is considered to have for administration and record keeping purposes. The required ValueSet used in this case is administrative-gender, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

HTML View

This code system http://hl7.org/fhir/administrative-gender defines the following codes:

CodeDisplayDefinition
maleMaleMale.
femaleFemaleFemale.
otherOtherOther.
unknownUnknownUnknown.

Table View

CodeSystem.id[0]administrative-gender
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].value[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].value[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].value[0]5
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[3].value[0]4.0.0
CodeSystem.url[0]http://hl7.org/fhir/administrative-gender
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.2
CodeSystem.version[0]4.0.1
CodeSystem.name[0]AdministrativeGender
CodeSystem.title[0]AdministrativeGender
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.description[0]The gender of a person used for administrative purposes.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/administrative-gender
CodeSystem.content[0]complete
CodeSystem.concept[0].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[0].extension[0].value[0]Male
CodeSystem.concept[0].code[0]male
CodeSystem.concept[0].display[0]Male
CodeSystem.concept[0].definition[0]Male.
CodeSystem.concept[1].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[1].extension[0].value[0]Female
CodeSystem.concept[1].code[0]female
CodeSystem.concept[1].display[0]Female
CodeSystem.concept[1].definition[0]Female.
CodeSystem.concept[2].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[2].extension[0].value[0]The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value.
CodeSystem.concept[2].code[0]other
CodeSystem.concept[2].display[0]Other
CodeSystem.concept[2].definition[0]Other.
CodeSystem.concept[3].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[3].extension[0].value[0]A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
CodeSystem.concept[3].code[0]unknown
CodeSystem.concept[3].display[0]Unknown
CodeSystem.concept[3].definition[0]Unknown.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="administrative-gender" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <url value="http://hl7.org/fhir/administrative-gender" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.2" />
    </identifier>
    <version value="4.0.1" />
    <name value="AdministrativeGender" />
    <title value="AdministrativeGender" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <description value="The gender of a person used for administrative purposes." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" />
    <content value="complete" />
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Male" />
        </extension>
        <code value="male" />
        <display value="Male" />
        <definition value="Male." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Female" />
        </extension>
        <code value="female" />
        <display value="Female" />
        <definition value="Female." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." />
        </extension>
        <code value="other" />
        <display value="Other" />
        <definition value="Other." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of &quot;unknown&quot;. (E.g. a local code sent as a translation that conveys &#39;unknown&#39;) Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to convey that it is the home phone number that is unknown.)" />
        </extension>
        <code value="unknown" />
        <display value="Unknown" />
        <definition value="Unknown." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "administrative-gender",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        }
    ],
    "url": "http://hl7.org/fhir/administrative-gender",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.2"
        }
    ],
    "version": "4.0.1",
    "name": "AdministrativeGender",
    "title": "AdministrativeGender",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "description": "The gender of a person used for administrative purposes.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender",
    "content": "complete",
    "concept":  [
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Male"
                }
            ],
            "code": "male",
            "display": "Male",
            "definition": "Male."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Female"
                }
            ],
            "code": "female",
            "display": "Female",
            "definition": "Female."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value."
                }
            ],
            "code": "other",
            "display": "Other",
            "definition": "Other."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of \"unknown\". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of \"H\" and a URL prefix of \"tel:\" to convey that it is the home phone number that is unknown.)"
                }
            ],
            "code": "unknown",
            "display": "Unknown",
            "definition": "Unknown."
        }
    ]
}


birthDate

The date on which the related person was born on.


address

Please note that the Address datatype used by this element has been standardized, see Address profile for more details.
Address where the related person can be contacted or visited.

photo

Image of the related person.


period

The period of time during which this relationship between patient and related person is or was active.


communication

A language which may be used to communicate with related person about the patient's health.

The preferred ValueSet used in this case is languages, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to observation-category by using the ConceptMap resource is encouraged.