UK Core Implementation Guide 1.0.0 - STU1 Pre-release

StructureDefinition Extension-UKCore-BirthSex

An extension to support the patient's phenotypic sex at birth.

Purpose

This extension extends the Patient resource to support the exchange of the patient's phenotypic sex at birth information as a Code, which is currently not supported by the FHIR standard.

Context of Use
Use on element Patient

Snapshot View

url1..1System.StringFixed Value
valueCodecode

Differential View

url1..1System.StringFixed Value
valueCodecode

Hybrid View

url1..1System.StringFixed Value
valueCodecode

Table View

Extension..1
Extension.url..
Extension.value[x]code1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-BirthSex" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" />
    <version value="1.0.0" />
    <name value="ExtensionUKCoreBirthSex" />
    <title value="Extension UK Core Birth Sex" />
    <status value="active" />
    <date value="2021-09-10" />
    <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="An extension to support the patient&#39;s phenotypic sex at birth." />
    <purpose value="This extension extends the Patient resource to support the exchange of the patient&#39;s phenotypic sex at birth information, as a Codeable Concept, which is currently not supported by the FHIR standard." />
    <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>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Patient" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="An extension to support the patient&#39;s phenotypic sex at birth." />
            <definition value="An extension to support the patient&#39;s phenotypic sex at birth." />
            <max value="1" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="A code that defines a patient&#39;s phenotypic sex at birth." />
            <definition value="A code that defines a patient&#39;s phenotypic sex at birth." />
            <min value="1" />
            <type>
                <code value="code" />
            </type>
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-BirthSex",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex",
    "version": "1.0.0",
    "name": "ExtensionUKCoreBirthSex",
    "title": "Extension UK Core Birth Sex",
    "status": "active",
    "date": "2021-09-10",
    "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": "An extension to support the patient's phenotypic sex at birth.",
    "purpose": "This extension extends the Patient resource to support the exchange of the patient's phenotypic sex at birth information, as a Codeable Concept, which is currently not supported by the FHIR standard.",
    "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"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Patient"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "An extension to support the patient's phenotypic sex at birth.",
                "definition": "An extension to support the patient's phenotypic sex at birth.",
                "max": "1"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "A code that defines a patient's phenotypic sex at birth.",
                "definition": "A code that defines a patient's phenotypic sex at birth.",
                "min": 1,
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex"
                }
            }
        ]
    }
}

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-BirthSex",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex",
    "version": "1.0.0",
    "name": "ExtensionUKCoreBirthSex",
    "title": "Extension UK Core Birth Sex",
    "status": "active",
    "date": "2021-09-10",
    "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": "An extension to support the patient's phenotypic sex at birth.",
    "purpose": "This extension extends the Patient resource to support the exchange of the patient's phenotypic sex at birth information, as a Codeable Concept, which is currently not supported by the FHIR standard.",
    "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"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Patient"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "An extension to support the patient's phenotypic sex at birth.",
                "definition": "An extension to support the patient's phenotypic sex at birth.",
                "max": "1"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "A code that defines a patient's phenotypic sex at birth.",
                "definition": "A code that defines a patient's phenotypic sex at birth.",
                "min": 1,
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex"
                }
            }
        ]
    }
}

back to top