UK Core Implementation Guide 0.3.0 STU1

StructureDefinition-UKCore-RelatedPerson

Defines the UK Core constraints and extensions on the RelatedPerson resource for the minimal set of data to query and retrieve related person information.

Profile Purpose

This profile allows exchange of information about a person that is involved in the care for an individual, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Snapshot View

contactPreferenceI0..1Extension(Complex)
contactRankI0..1Extension(positiveInt)
copyCorrespondenceIndicatorI0..1Extension(boolean)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
relationshipΣ0..*CodeableConceptBinding
nameΣ0..*HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*Address
photoI0..*Attachment
periodI0..1Period
language1..1CodeableConceptBinding
preferred0..1boolean

Differential View

contactPreferenceI0..1Extension(Complex)
contactRankI0..1Extension(positiveInt)
copyCorrespondenceIndicatorI0..1Extension(boolean)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
relationshipΣ0..*CodeableConceptBinding
nameΣ0..*HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*Address
photoI0..*Attachment
periodI0..1Period
language1..1CodeableConceptBinding
preferred0..1boolean

Hybrid View

contactPreferenceI0..1Extension(Complex)
contactRankI0..1Extension(positiveInt)
copyCorrespondenceIndicatorI0..1Extension(boolean)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
relationshipΣ0..*CodeableConceptBinding
nameΣ0..*HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*Address
photoI0..*Attachment
periodI0..1Period
language1..1CodeableConceptBinding
preferred0..1boolean

Table View

RelatedPerson..
RelatedPerson.extension0..
RelatedPerson.extensionExtension0..
RelatedPerson.extensionExtension0..
RelatedPerson.extensionExtension0..
RelatedPerson.identifier..
RelatedPerson.identifier.assignerReference(UK Core Organization)..
RelatedPerson.patientReference(UK Core Patient)..
RelatedPerson.patient.identifier..
RelatedPerson.patient.identifier.assignerReference(UK Core Organization)..
RelatedPerson.relationship..
RelatedPerson.telecom..
RelatedPerson.telecom.system..
RelatedPerson.telecom.system.extension0..
RelatedPerson.telecom.system.extensionExtension0..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-RelatedPerson" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
    <version value="2.3.0" />
    <name value="UKCoreRelatedPerson" />
    <title value="UK Core RelatedPerson" />
    <status value="active" />
    <date value="2022-03-01" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the RelatedPerson resource for the minimal set of data to query and retrieve related person information." />
    <purpose value="This profile allows exchange of information about a person that is involved in the care for an individual, but who is not the target of healthcare, nor has a formal responsibility in the care process." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="RelatedPerson" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
    <derivation value="constraint" />
    <differential>
        <element id="RelatedPerson.extension">
            <path value="RelatedPerson.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="RelatedPerson.extension:contactPreference">
            <path value="RelatedPerson.extension" />
            <sliceName value="contactPreference" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" />
            </type>
        </element>
        <element id="RelatedPerson.extension:contactRank">
            <path value="RelatedPerson.extension" />
            <sliceName value="contactRank" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" />
            </type>
        </element>
        <element id="RelatedPerson.extension:copyCorrespondenceIndicator">
            <path value="RelatedPerson.extension" />
            <sliceName value="copyCorrespondenceIndicator" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" />
            </type>
        </element>
        <element id="RelatedPerson.identifier.assigner">
            <path value="RelatedPerson.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="RelatedPerson.patient">
            <path value="RelatedPerson.patient" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="RelatedPerson.patient.identifier.assigner">
            <path value="RelatedPerson.patient.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="RelatedPerson.relationship">
            <path value="RelatedPerson.relationship" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType" />
            </binding>
        </element>
        <element id="RelatedPerson.telecom.system.extension">
            <path value="RelatedPerson.telecom.system.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="RelatedPerson.telecom.system.extension:otherContactSystem">
            <path value="RelatedPerson.telecom.system.extension" />
            <sliceName value="otherContactSystem" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-RelatedPerson",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
    "version": "2.3.0",
    "name": "UKCoreRelatedPerson",
    "title": "UK Core RelatedPerson",
    "status": "active",
    "date": "2022-03-01",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the RelatedPerson resource for the minimal set of data to query and retrieve related person information.",
    "purpose": "This profile allows exchange of information about a person that is involved in the care for an individual, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "RelatedPerson",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "RelatedPerson.extension",
                "path": "RelatedPerson.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "RelatedPerson.extension:contactPreference",
                "path": "RelatedPerson.extension",
                "sliceName": "contactPreference",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.extension:contactRank",
                "path": "RelatedPerson.extension",
                "sliceName": "contactRank",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.extension:copyCorrespondenceIndicator",
                "path": "RelatedPerson.extension",
                "sliceName": "copyCorrespondenceIndicator",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.identifier.assigner",
                "path": "RelatedPerson.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.patient",
                "path": "RelatedPerson.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.patient.identifier.assigner",
                "path": "RelatedPerson.patient.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "RelatedPerson.relationship",
                "path": "RelatedPerson.relationship",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType"
                }
            },
            {
                "id": "RelatedPerson.telecom.system.extension",
                "path": "RelatedPerson.telecom.system.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "RelatedPerson.telecom.system.extension:otherContactSystem",
                "path": "RelatedPerson.telecom.system.extension",
                "sliceName": "otherContactSystem",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem"
                        ]
                    }
                ]
            }
        ]
    }
}

Example Usage Scenarios

The following are example usage scenarios for the UK Core RelatedPerson profile:

  • Query for related person information for a given Patient
  • Exchange related person information within a FHIR document or message.

Profile specific implementation guidance:

extension:contactPreference

More information about this extension can be found using the link below.

Extension UKCore-ContactPreference.


extension:contactRank

More information about this extension can be found using the link below.

Extension UKCore-ContactRank.


extension:copyCorrespondenceIndicator

More information about this extension can be found using the link below.

Extension UKCore-CopyCorrespondenceIndicator.


identifier

A human identifier for this person. Although related persons can be identified using NHS Numbers, third party NHS numbers are not normally used in patient records. For this reason, the use of this identifier for a related person is dependant on the use case.


active

Whether this related person's record is in active use.


patient

The patient this person is related to. The resource being referenced should conform to the following:


relationship

The nature of the relationship using a code from ValueSet UKCore-PersonRelationshipType.


name

A name associated with the person using HumanName data type.


telecom

A contact detail for the person using the ContactPoint data type.


gender

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

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].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]5
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[3].valueCode[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].valueString[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].valueString[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].valueString[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].valueString[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 related person's date of birth. An approximate date may be used (e.g. just the year) where the full date is not known.

birthDate includes an extension Common Extension patient-birthTime This should be included when the birth time is relevant.


address

The address of the related person using the Address datatype.


photo

Image of the person.


period

The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.


communication

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


back to top