UK Core Implementation Guide 0.2.0 - STU1

UK Core Person Marital Status

HTML View

Filters

CodeDescriptionOperatorValue
ApplicableCountryFilter to identify an applicable country for a conceptEqualApplicableCountry

This code system https://fhir.hl7.org.uk/CodeSystem/UKCore-PersonMaritalStatus defines the following codes:

CodeDisplayApplicableCountry
married-or-civil-partnerMarried/Civil PartnerEngland
civil-partnerCivil PartnerScotland
never-married-nor-registered-civil-partnershipNever married nor registered civil partnershipScotland
divorced-or-civil-partnership-dissolvedDivorced/Person whose Civil Partnership has been dissolvedEngland
civil-partnership-dissolvedPerson whose Civil Partnership has been dissolvedScotland
widowed-or-surviving-civil-partnerWidowed/Surviving Civil PartnerEngland
surviving-civil-partnerSurviving Civil PartnerScotland
not-disclosed-or-unknownNot disclosed or unknownWales
not-disclosedNot disclosedEngland

Properties

CodeURLDescriptionType
ApplicableCountryA UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern IrelandString

Table View

CodeSystem.id[0]UKCore-PersonMaritalStatus
CodeSystem.url[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-PersonMaritalStatus
CodeSystem.version[0]1.0.0
CodeSystem.name[0]UKCorePersonMaritalStatus
CodeSystem.title[0]UK Core Person Marital Status
CodeSystem.status[0]active
CodeSystem.date[0]2021-09-10
CodeSystem.publisher[0]HL7 UK
CodeSystem.contact[0].name[0]HL7 UK
CodeSystem.contact[0].telecom[0].system[0]email
CodeSystem.contact[0].telecom[0].value[0]secretariat@hl7.org.uk
CodeSystem.contact[0].telecom[0].use[0]work
CodeSystem.contact[0].telecom[0].rank[0]1
CodeSystem.contact[1].name[0]NHS Digital
CodeSystem.contact[1].telecom[0].system[0]email
CodeSystem.contact[1].telecom[0].value[0]interoperabilityteam@nhs.net
CodeSystem.contact[1].telecom[0].use[0]work
CodeSystem.contact[1].telecom[0].rank[0]2
CodeSystem.description[0]A set of code from Data Dictionaries used within the UK not already covered by more specific concepts in the HL7 FHIR standard Value Set
CodeSystem.copyright[0]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.
CodeSystem.caseSensitive[0]True
CodeSystem.content[0]complete
CodeSystem.filter[0].code[0]ApplicableCountry
CodeSystem.filter[0].description[0]Filter to identify an applicable country for a concept
CodeSystem.filter[0].operator[0]=
CodeSystem.filter[0].value[0]ApplicableCountry
CodeSystem.property[0].code[0]ApplicableCountry
CodeSystem.property[0].description[0]A UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern Ireland
CodeSystem.property[0].type[0]string
CodeSystem.concept[0].code[0]married-or-civil-partner
CodeSystem.concept[0].display[0]Married/Civil Partner
CodeSystem.concept[0].property[0].code[0]ApplicableCountry
CodeSystem.concept[0].property[0].valueString[0]England
CodeSystem.concept[1].code[0]civil-partner
CodeSystem.concept[1].display[0]Civil Partner
CodeSystem.concept[1].property[0].code[0]ApplicableCountry
CodeSystem.concept[1].property[0].valueString[0]Scotland
CodeSystem.concept[1].property[1].code[0]ApplicableCountry
CodeSystem.concept[1].property[1].valueString[0]Wales
CodeSystem.concept[2].code[0]never-married-nor-registered-civil-partnership
CodeSystem.concept[2].display[0]Never married nor registered civil partnership
CodeSystem.concept[2].property[0].code[0]ApplicableCountry
CodeSystem.concept[2].property[0].valueString[0]Scotland
CodeSystem.concept[3].code[0]divorced-or-civil-partnership-dissolved
CodeSystem.concept[3].display[0]Divorced/Person whose Civil Partnership has been dissolved
CodeSystem.concept[3].property[0].code[0]ApplicableCountry
CodeSystem.concept[3].property[0].valueString[0]England
CodeSystem.concept[4].code[0]civil-partnership-dissolved
CodeSystem.concept[4].display[0]Person whose Civil Partnership has been dissolved
CodeSystem.concept[4].property[0].code[0]ApplicableCountry
CodeSystem.concept[4].property[0].valueString[0]Scotland
CodeSystem.concept[4].property[1].code[0]ApplicableCountry
CodeSystem.concept[4].property[1].valueString[0]Wales
CodeSystem.concept[5].code[0]widowed-or-surviving-civil-partner
CodeSystem.concept[5].display[0]Widowed/Surviving Civil Partner
CodeSystem.concept[5].property[0].code[0]ApplicableCountry
CodeSystem.concept[5].property[0].valueString[0]England
CodeSystem.concept[6].code[0]surviving-civil-partner
CodeSystem.concept[6].display[0]Surviving Civil Partner
CodeSystem.concept[6].property[0].code[0]ApplicableCountry
CodeSystem.concept[6].property[0].valueString[0]Scotland
CodeSystem.concept[6].property[1].code[0]ApplicableCountry
CodeSystem.concept[6].property[1].valueString[0]Wales
CodeSystem.concept[7].code[0]not-disclosed-or-unknown
CodeSystem.concept[7].display[0]Not disclosed or unknown
CodeSystem.concept[7].property[0].code[0]ApplicableCountry
CodeSystem.concept[7].property[0].valueString[0]Wales
CodeSystem.concept[8].code[0]not-disclosed
CodeSystem.concept[8].display[0]Not disclosed
CodeSystem.concept[8].property[0].code[0]ApplicableCountry
CodeSystem.concept[8].property[0].valueString[0]England

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="UKCore-PersonMaritalStatus" />
    <url value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PersonMaritalStatus" />
    <version value="1.0.0" />
    <name value="UKCorePersonMaritalStatus" />
    <title value="UK Core Person Marital Status" />
    <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="A set of code from Data Dictionaries used within the UK not already covered by more specific concepts in the HL7 FHIR standard Value Set" />
    <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." />
    <caseSensitive value="true" />
    <content value="complete" />
    <filter>
        <code value="ApplicableCountry" />
        <description value="Filter to identify an applicable country for a concept" />
        <operator value="=" />
        <value value="ApplicableCountry" />
    </filter>
    <property>
        <code value="ApplicableCountry" />
        <description value="A UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern Ireland" />
        <type value="string" />
    </property>
    <concept>
        <code value="married-or-civil-partner" />
        <display value="Married/Civil Partner" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
    </concept>
    <concept>
        <code value="civil-partner" />
        <display value="Civil Partner" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Scotland" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="never-married-nor-registered-civil-partnership" />
        <display value="Never married nor registered civil partnership" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Scotland" />
        </property>
    </concept>
    <concept>
        <code value="divorced-or-civil-partnership-dissolved" />
        <display value="Divorced/Person whose Civil Partnership has been dissolved" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
    </concept>
    <concept>
        <code value="civil-partnership-dissolved" />
        <display value="Person whose Civil Partnership has been dissolved" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Scotland" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="widowed-or-surviving-civil-partner" />
        <display value="Widowed/Surviving Civil Partner" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
    </concept>
    <concept>
        <code value="surviving-civil-partner" />
        <display value="Surviving Civil Partner" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Scotland" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="not-disclosed-or-unknown" />
        <display value="Not disclosed or unknown" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="not-disclosed" />
        <display value="Not disclosed" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "UKCore-PersonMaritalStatus",
    "url": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PersonMaritalStatus",
    "version": "1.0.0",
    "name": "UKCorePersonMaritalStatus",
    "title": "UK Core Person Marital Status",
    "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": "A set of code from Data Dictionaries used within the UK not already covered by more specific concepts in the HL7 FHIR standard Value Set",
    "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.",
    "caseSensitive": true,
    "content": "complete",
    "filter":  [
        {
            "code": "ApplicableCountry",
            "description": "Filter to identify an applicable country for a concept",
            "operator":  [
                "="
            ],
            "value": "ApplicableCountry"
        }
    ],
    "property":  [
        {
            "code": "ApplicableCountry",
            "description": "A UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern Ireland",
            "type": "string"
        }
    ],
    "concept":  [
        {
            "code": "married-or-civil-partner",
            "display": "Married/Civil Partner",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                }
            ]
        },
        {
            "code": "civil-partner",
            "display": "Civil Partner",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "Scotland"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "never-married-nor-registered-civil-partnership",
            "display": "Never married nor registered civil partnership",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "Scotland"
                }
            ]
        },
        {
            "code": "divorced-or-civil-partnership-dissolved",
            "display": "Divorced/Person whose Civil Partnership has been dissolved",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                }
            ]
        },
        {
            "code": "civil-partnership-dissolved",
            "display": "Person whose Civil Partnership has been dissolved",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "Scotland"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "widowed-or-surviving-civil-partner",
            "display": "Widowed/Surviving Civil Partner",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                }
            ]
        },
        {
            "code": "surviving-civil-partner",
            "display": "Surviving Civil Partner",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "Scotland"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "not-disclosed-or-unknown",
            "display": "Not disclosed or unknown",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "not-disclosed",
            "display": "Not disclosed",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                }
            ]
        }
    ]
}


back to top