UK Core Implementation Guide 0.2.0 - STU1

DataTypes

This page gives guidance on the representation of constructs like:

  • Representing structured addresses using Address
  • Representing structured names using HumanName
  • Representing contact methods such as telephones using ContactPoint etc.

ContactPoint

Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.

The Contact datatype has the following elements and this is an overview of the datatype with additional UK Core guidance. The full definition is available from the FHIR standard.

Element type Usage Guidance Description
system code should be present Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.
value string must be present The actual contact point details
use code may be present Identifies the purpose for the contact point.
rank positiveInt may be present 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.
period Period may be present Time period when the contact point was/is in use.

Additional Information and Guidance

This section contains extra guidance and information about the use of this datatype in the UK Core FHIR implementations.

system

Identifies the type of system used for the contact point.

HTML View

This code system http://hl7.org/fhir/contact-point-system defines the following codes:

CodeDisplayDefinition
phonePhoneThe value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.
faxFaxThe value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.
emailEmailThe value is an email address.
pagerPagerThe value is a pager number. These may be local pager numbers that are only usable on a particular pager system.
urlURLA contact that is not a phone, fax, pager or email address and is expressed as a URL. This is intended for various institutional or personal contacts including web sites, blogs, Skype, Twitter, Facebook, etc. Do not use for email addresses.
smsSMSA contact that can be used for sending an sms message (e.g. mobile phones, some landlines).
otherOtherA contact that is not a phone, fax, page or email address and is not expressible as a URL. E.g. Internal mail address. This SHOULD NOT be used for contacts that are expressible as a URL (e.g. Skype, Twitter, Facebook, etc.) Extensions may be used to distinguish "other" contact types.

Table View

CodeSystem.id[0]contact-point-system
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]fhir
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-normative-version
CodeSystem.extension[2].valueCode[0]4.0.0
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[3].valueInteger[0]5
CodeSystem.url[0]http://hl7.org/fhir/contact-point-system
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.72
CodeSystem.version[0]4.0.1
CodeSystem.name[0]ContactPointSystem
CodeSystem.title[0]ContactPointSystem
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]Telecommunications form for contact point.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/contact-point-system
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]phone
CodeSystem.concept[0].display[0]Phone
CodeSystem.concept[0].definition[0]The value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.
CodeSystem.concept[1].code[0]fax
CodeSystem.concept[1].display[0]Fax
CodeSystem.concept[1].definition[0]The value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.
CodeSystem.concept[2].code[0]email
CodeSystem.concept[2].display[0]Email
CodeSystem.concept[2].definition[0]The value is an email address.
CodeSystem.concept[3].code[0]pager
CodeSystem.concept[3].display[0]Pager
CodeSystem.concept[3].definition[0]The value is a pager number. These may be local pager numbers that are only usable on a particular pager system.
CodeSystem.concept[4].code[0]url
CodeSystem.concept[4].display[0]URL
CodeSystem.concept[4].definition[0]A contact that is not a phone, fax, pager or email address and is expressed as a URL. This is intended for various institutional or personal contacts including web sites, blogs, Skype, Twitter, Facebook, etc. Do not use for email addresses.
CodeSystem.concept[5].code[0]sms
CodeSystem.concept[5].display[0]SMS
CodeSystem.concept[5].definition[0]A contact that can be used for sending an sms message (e.g. mobile phones, some landlines).
CodeSystem.concept[6].code[0]other
CodeSystem.concept[6].display[0]Other
CodeSystem.concept[6].definition[0]A contact that is not a phone, fax, page or email address and is not expressible as a URL. E.g. Internal mail address. This SHOULD NOT be used for contacts that are expressible as a URL (e.g. Skype, Twitter, Facebook, etc.) Extensions may be used to distinguish "other" contact types.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="contact-point-system" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <url value="http://hl7.org/fhir/contact-point-system" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.72" />
    </identifier>
    <version value="4.0.1" />
    <name value="ContactPointSystem" />
    <title value="ContactPointSystem" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="Telecommunications form for contact point." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-system" />
    <content value="complete" />
    <concept>
        <code value="phone" />
        <display value="Phone" />
        <definition value="The value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required." />
    </concept>
    <concept>
        <code value="fax" />
        <display value="Fax" />
        <definition value="The value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required." />
    </concept>
    <concept>
        <code value="email" />
        <display value="Email" />
        <definition value="The value is an email address." />
    </concept>
    <concept>
        <code value="pager" />
        <display value="Pager" />
        <definition value="The value is a pager number. These may be local pager numbers that are only usable on a particular pager system." />
    </concept>
    <concept>
        <code value="url" />
        <display value="URL" />
        <definition value="A contact that is not a phone, fax, pager or email address and is expressed as a URL.  This is intended for various institutional or personal contacts including web sites, blogs, Skype, Twitter, Facebook, etc. Do not use for email addresses." />
    </concept>
    <concept>
        <code value="sms" />
        <display value="SMS" />
        <definition value="A contact that can be used for sending an sms message (e.g. mobile phones, some landlines)." />
    </concept>
    <concept>
        <code value="other" />
        <display value="Other" />
        <definition value="A contact that is not a phone, fax, page or email address and is not expressible as a URL.  E.g. Internal mail address.  This SHOULD NOT be used for contacts that are expressible as a URL (e.g. Skype, Twitter, Facebook, etc.)  Extensions may be used to distinguish &quot;other&quot; contact types." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "contact-point-system",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        }
    ],
    "url": "http://hl7.org/fhir/contact-point-system",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.72"
        }
    ],
    "version": "4.0.1",
    "name": "ContactPointSystem",
    "title": "ContactPointSystem",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "Telecommunications form for contact point.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system",
    "content": "complete",
    "concept":  [
        {
            "code": "phone",
            "display": "Phone",
            "definition": "The value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required."
        },
        {
            "code": "fax",
            "display": "Fax",
            "definition": "The value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required."
        },
        {
            "code": "email",
            "display": "Email",
            "definition": "The value is an email address."
        },
        {
            "code": "pager",
            "display": "Pager",
            "definition": "The value is a pager number. These may be local pager numbers that are only usable on a particular pager system."
        },
        {
            "code": "url",
            "display": "URL",
            "definition": "A contact that is not a phone, fax, pager or email address and is expressed as a URL.  This is intended for various institutional or personal contacts including web sites, blogs, Skype, Twitter, Facebook, etc. Do not use for email addresses."
        },
        {
            "code": "sms",
            "display": "SMS",
            "definition": "A contact that can be used for sending an sms message (e.g. mobile phones, some landlines)."
        },
        {
            "code": "other",
            "display": "Other",
            "definition": "A contact that is not a phone, fax, page or email address and is not expressible as a URL.  E.g. Internal mail address.  This SHOULD NOT be used for contacts that are expressible as a URL (e.g. Skype, Twitter, Facebook, etc.)  Extensions may be used to distinguish \"other\" contact types."
        }
    ]
}

use

The use of the contact point is done using following codes

HTML View

This code system http://hl7.org/fhir/contact-point-use defines the following codes:

CodeDisplayDefinition
homeHomeA communication contact point at a home; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available.
workWorkAn office contact point. First choice for business related contacts during business hours.
tempTempA temporary contact point. The period can provide more detailed information.
oldOldThis contact point is no longer in use (or was never correct, but retained for records).
mobileMobileA telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business.

Table View

CodeSystem.id[0]contact-point-use
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]fhir
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-normative-version
CodeSystem.extension[2].valueCode[0]4.0.0
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[3].valueInteger[0]5
CodeSystem.url[0]http://hl7.org/fhir/contact-point-use
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.74
CodeSystem.version[0]4.0.1
CodeSystem.name[0]ContactPointUse
CodeSystem.title[0]ContactPointUse
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]Use of contact point.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/contact-point-use
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]home
CodeSystem.concept[0].display[0]Home
CodeSystem.concept[0].definition[0]A communication contact point at a home; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available.
CodeSystem.concept[1].code[0]work
CodeSystem.concept[1].display[0]Work
CodeSystem.concept[1].definition[0]An office contact point. First choice for business related contacts during business hours.
CodeSystem.concept[2].code[0]temp
CodeSystem.concept[2].display[0]Temp
CodeSystem.concept[2].definition[0]A temporary contact point. The period can provide more detailed information.
CodeSystem.concept[3].code[0]old
CodeSystem.concept[3].display[0]Old
CodeSystem.concept[3].definition[0]This contact point is no longer in use (or was never correct, but retained for records).
CodeSystem.concept[4].code[0]mobile
CodeSystem.concept[4].display[0]Mobile
CodeSystem.concept[4].definition[0]A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="contact-point-use" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <url value="http://hl7.org/fhir/contact-point-use" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.74" />
    </identifier>
    <version value="4.0.1" />
    <name value="ContactPointUse" />
    <title value="ContactPointUse" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="Use of contact point." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-use" />
    <content value="complete" />
    <concept>
        <code value="home" />
        <display value="Home" />
        <definition value="A communication contact point at a home; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available." />
    </concept>
    <concept>
        <code value="work" />
        <display value="Work" />
        <definition value="An office contact point. First choice for business related contacts during business hours." />
    </concept>
    <concept>
        <code value="temp" />
        <display value="Temp" />
        <definition value="A temporary contact point. The period can provide more detailed information." />
    </concept>
    <concept>
        <code value="old" />
        <display value="Old" />
        <definition value="This contact point is no longer in use (or was never correct, but retained for records)." />
    </concept>
    <concept>
        <code value="mobile" />
        <display value="Mobile" />
        <definition value="A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "contact-point-use",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        }
    ],
    "url": "http://hl7.org/fhir/contact-point-use",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.74"
        }
    ],
    "version": "4.0.1",
    "name": "ContactPointUse",
    "title": "ContactPointUse",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "Use of contact point.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use",
    "content": "complete",
    "concept":  [
        {
            "code": "home",
            "display": "Home",
            "definition": "A communication contact point at a home; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available."
        },
        {
            "code": "work",
            "display": "Work",
            "definition": "An office contact point. First choice for business related contacts during business hours."
        },
        {
            "code": "temp",
            "display": "Temp",
            "definition": "A temporary contact point. The period can provide more detailed information."
        },
        {
            "code": "old",
            "display": "Old",
            "definition": "This contact point is no longer in use (or was never correct, but retained for records)."
        },
        {
            "code": "mobile",
            "display": "Mobile",
            "definition": "A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business."
        }
    ]
}

Address

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

The Address datatype has the following elements and this is an overview of the datatype with additional UK Core guidance. The full definition is available from the FHIR standard.

Element type Usage Guidance Description
use code should be present purpose of this address
type code should be present The type of address
text string may be present Text representation of the address
line string should be present Street name, number, direction & P.O. Box etc.This repeating element order: The order in which lines should appear in an address label
city string should be present Name of city, town etc.
district string may be present District name (aka county)
state string may be present Sub-unit of country (abbreviations ok)
postalCode string should be present Postal code for area
country string may be present Country (e.g. can be ISO 3166 2 or 3 letter code)
period Period may be present Time period when the address was/is in use

Additional Information and Guidance

This section contains extra guidance and information about the use of this datatype in the UK Core FHIR implementations.

use

Purpose of this address.

HTML View

This code system http://hl7.org/fhir/address-use defines the following codes:

CodeDisplayDefinition
homeHomeA communication address at a home.
workWorkAn office address. First choice for business related contacts during business hours.
tempTemporaryA temporary address. The period can provide more detailed information.
oldOld / IncorrectThis address is no longer in use (or was never correct but retained for records).
billingBillingAn address to be used to send bills, invoices, receipts etc.

Table View

CodeSystem.id[0]address-use
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]fhir
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-normative-version
CodeSystem.extension[2].valueCode[0]4.0.0
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[3].valueInteger[0]5
CodeSystem.url[0]http://hl7.org/fhir/address-use
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.68
CodeSystem.version[0]4.0.1
CodeSystem.name[0]AddressUse
CodeSystem.title[0]AddressUse
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]The use of an address.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/address-use
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]home
CodeSystem.concept[0].display[0]Home
CodeSystem.concept[0].definition[0]A communication address at a home.
CodeSystem.concept[1].code[0]work
CodeSystem.concept[1].display[0]Work
CodeSystem.concept[1].definition[0]An office address. First choice for business related contacts during business hours.
CodeSystem.concept[2].code[0]temp
CodeSystem.concept[2].display[0]Temporary
CodeSystem.concept[2].definition[0]A temporary address. The period can provide more detailed information.
CodeSystem.concept[3].code[0]old
CodeSystem.concept[3].display[0]Old / Incorrect
CodeSystem.concept[3].definition[0]This address is no longer in use (or was never correct but retained for records).
CodeSystem.concept[4].code[0]billing
CodeSystem.concept[4].display[0]Billing
CodeSystem.concept[4].definition[0]An address to be used to send bills, invoices, receipts etc.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="address-use" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <url value="http://hl7.org/fhir/address-use" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.68" />
    </identifier>
    <version value="4.0.1" />
    <name value="AddressUse" />
    <title value="AddressUse" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="The use of an address." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/address-use" />
    <content value="complete" />
    <concept>
        <code value="home" />
        <display value="Home" />
        <definition value="A communication address at a home." />
    </concept>
    <concept>
        <code value="work" />
        <display value="Work" />
        <definition value="An office address. First choice for business related contacts during business hours." />
    </concept>
    <concept>
        <code value="temp" />
        <display value="Temporary" />
        <definition value="A temporary address. The period can provide more detailed information." />
    </concept>
    <concept>
        <code value="old" />
        <display value="Old / Incorrect" />
        <definition value="This address is no longer in use (or was never correct but retained for records)." />
    </concept>
    <concept>
        <code value="billing" />
        <display value="Billing" />
        <definition value="An address to be used to send bills, invoices, receipts etc." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "address-use",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        }
    ],
    "url": "http://hl7.org/fhir/address-use",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.68"
        }
    ],
    "version": "4.0.1",
    "name": "AddressUse",
    "title": "AddressUse",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "The use of an address.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/address-use",
    "content": "complete",
    "concept":  [
        {
            "code": "home",
            "display": "Home",
            "definition": "A communication address at a home."
        },
        {
            "code": "work",
            "display": "Work",
            "definition": "An office address. First choice for business related contacts during business hours."
        },
        {
            "code": "temp",
            "display": "Temporary",
            "definition": "A temporary address. The period can provide more detailed information."
        },
        {
            "code": "old",
            "display": "Old / Incorrect",
            "definition": "This address is no longer in use (or was never correct but retained for records)."
        },
        {
            "code": "billing",
            "display": "Billing",
            "definition": "An address to be used to send bills, invoices, receipts etc."
        }
    ]
}

type

The type of address.For example whether the address is a physical address and can be visited or is just a mailbox address.

HTML View

This code system http://hl7.org/fhir/address-type defines the following codes:

CodeDisplayDefinition
postalPostalMailing addresses - PO Boxes and care-of addresses.
physicalPhysicalA physical address that can be visited.
bothPostal & PhysicalAn address that is both physical and postal.

Table View

CodeSystem.id[0]address-type
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]fhir
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-normative-version
CodeSystem.extension[2].valueCode[0]4.0.0
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[3].valueInteger[0]5
CodeSystem.url[0]http://hl7.org/fhir/address-type
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.70
CodeSystem.version[0]4.0.1
CodeSystem.name[0]AddressType
CodeSystem.title[0]AddressType
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]The type of an address (physical / postal).
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/address-type
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]postal
CodeSystem.concept[0].display[0]Postal
CodeSystem.concept[0].definition[0]Mailing addresses - PO Boxes and care-of addresses.
CodeSystem.concept[1].code[0]physical
CodeSystem.concept[1].display[0]Physical
CodeSystem.concept[1].definition[0]A physical address that can be visited.
CodeSystem.concept[2].code[0]both
CodeSystem.concept[2].display[0]Postal & Physical
CodeSystem.concept[2].definition[0]An address that is both physical and postal.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="address-type" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <url value="http://hl7.org/fhir/address-type" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.70" />
    </identifier>
    <version value="4.0.1" />
    <name value="AddressType" />
    <title value="AddressType" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="The type of an address (physical / postal)." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/address-type" />
    <content value="complete" />
    <concept>
        <code value="postal" />
        <display value="Postal" />
        <definition value="Mailing addresses - PO Boxes and care-of addresses." />
    </concept>
    <concept>
        <code value="physical" />
        <display value="Physical" />
        <definition value="A physical address that can be visited." />
    </concept>
    <concept>
        <code value="both" />
        <display value="Postal &amp; Physical" />
        <definition value="An address that is both physical and postal." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "address-type",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        }
    ],
    "url": "http://hl7.org/fhir/address-type",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.70"
        }
    ],
    "version": "4.0.1",
    "name": "AddressType",
    "title": "AddressType",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "The type of an address (physical / postal).",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/address-type",
    "content": "complete",
    "concept":  [
        {
            "code": "postal",
            "display": "Postal",
            "definition": "Mailing addresses - PO Boxes and care-of addresses."
        },
        {
            "code": "physical",
            "display": "Physical",
            "definition": "A physical address that can be visited."
        },
        {
            "code": "both",
            "display": "Postal & Physical",
            "definition": "An address that is both physical and postal."
        }
    ]
}

Unstructured Addresses

text

Text representation of the address. This should only be used if a structured address as detailed below cannot be supported. It may be present in addition to a structured address.

Structured Addresses

Structured addresses should be used whenever possible as detailed below.

line

Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label. Parts of the address that have distinct element listed below should not appear in the address line elements.

The following elements should be used to carry the associated information.

  • city - Name of city, town etc.
  • district - District name (aka county)
  • state - Sub-unit of country (abbreviations ok)
  • Postal - Code for area
  • country - Country (e.g. can be ISO 3166 2 or 3 letter code).

HumanName

A name of a human with text, parts and usage information.

Names may be changed or repudiated. People may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts is not always significant. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems SHALL care about name parts around the world varies widely.

The HumanName datatype has the following elements and this is an overview of the datatype with additional UK Core guidance. The full definition is available from the FHIR standard.

Element type Usage Guidance Description
use code should be present Identifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names.Applications can assume that a name is current unless it explicitly says that it is temporary or old.
text string may be present Short description Text representation of the full name. Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
family string should be present Family name (often called 'Surname')
given string should be present Given names (not always 'first'). Includes middle names. This repeating element order: Given Names appear in the correct order for presenting the name
prefix string may be present Parts that come before the name. This repeating element order: Prefixes appear in the correct order for presenting the name
suffix string may be present Parts that come after the name. This repeating element order: Suffixes appear in the correct order for presenting the name
period Period may be present Time period when name was/is in use

Additional Information and Guidance

This section contains extra guidance and information about the use of this datatype in the UK Core FHIR implementations.

use

Identifies the purpose for this name.

HTML View

This code system http://hl7.org/fhir/name-use defines the following codes:

LvlCodeDisplayDefinition
1usualUsualKnown as/conventional/the one you normally use.
1officialOfficialThe formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
1tempTempA temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.
1nicknameNicknameA name that is used to address the person in an informal manner, but is not part of their formal or usual name.
1anonymousAnonymousAnonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
1oldOldThis name is no longer in use (or was never correct, but retained for records).
2  maidenName changed for MarriageA name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name.

Table View

CodeSystem.id[0]name-use
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]fhir
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-normative-version
CodeSystem.extension[2].valueCode[0]4.0.0
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[3].valueInteger[0]5
CodeSystem.url[0]http://hl7.org/fhir/name-use
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.66
CodeSystem.version[0]4.0.1
CodeSystem.name[0]NameUse
CodeSystem.title[0]NameUse
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]The use of a human name.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/name-use
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]usual
CodeSystem.concept[0].display[0]Usual
CodeSystem.concept[0].definition[0]Known as/conventional/the one you normally use.
CodeSystem.concept[1].code[0]official
CodeSystem.concept[1].display[0]Official
CodeSystem.concept[1].definition[0]The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
CodeSystem.concept[2].code[0]temp
CodeSystem.concept[2].display[0]Temp
CodeSystem.concept[2].definition[0]A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.
CodeSystem.concept[3].code[0]nickname
CodeSystem.concept[3].display[0]Nickname
CodeSystem.concept[3].definition[0]A name that is used to address the person in an informal manner, but is not part of their formal or usual name.
CodeSystem.concept[4].code[0]anonymous
CodeSystem.concept[4].display[0]Anonymous
CodeSystem.concept[4].definition[0]Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
CodeSystem.concept[5].code[0]old
CodeSystem.concept[5].display[0]Old
CodeSystem.concept[5].definition[0]This name is no longer in use (or was never correct, but retained for records).
CodeSystem.concept[5].concept[0].code[0]maiden
CodeSystem.concept[5].concept[0].display[0]Name changed for Marriage
CodeSystem.concept[5].concept[0].definition[0]A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="name-use" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <url value="http://hl7.org/fhir/name-use" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.66" />
    </identifier>
    <version value="4.0.1" />
    <name value="NameUse" />
    <title value="NameUse" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="The use of a human name." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/name-use" />
    <content value="complete" />
    <concept>
        <code value="usual" />
        <display value="Usual" />
        <definition value="Known as/conventional/the one you normally use." />
    </concept>
    <concept>
        <code value="official" />
        <display value="Official" />
        <definition value="The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called &quot;legal name&quot;." />
    </concept>
    <concept>
        <code value="temp" />
        <display value="Temp" />
        <definition value="A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations." />
    </concept>
    <concept>
        <code value="nickname" />
        <display value="Nickname" />
        <definition value="A name that is used to address the person in an informal manner, but is not part of their formal or usual name." />
    </concept>
    <concept>
        <code value="anonymous" />
        <display value="Anonymous" />
        <definition value="Anonymous assigned name, alias, or pseudonym (used to protect a person&#39;s identity for privacy reasons)." />
    </concept>
    <concept>
        <code value="old" />
        <display value="Old" />
        <definition value="This name is no longer in use (or was never correct, but retained for records)." />
        <concept>
            <code value="maiden" />
            <display value="Name changed for Marriage" />
            <definition value="A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person&#39;s name." />
        </concept>
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "name-use",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        }
    ],
    "url": "http://hl7.org/fhir/name-use",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.66"
        }
    ],
    "version": "4.0.1",
    "name": "NameUse",
    "title": "NameUse",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "The use of a human name.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/name-use",
    "content": "complete",
    "concept":  [
        {
            "code": "usual",
            "display": "Usual",
            "definition": "Known as/conventional/the one you normally use."
        },
        {
            "code": "official",
            "display": "Official",
            "definition": "The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called \"legal name\"."
        },
        {
            "code": "temp",
            "display": "Temp",
            "definition": "A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations."
        },
        {
            "code": "nickname",
            "display": "Nickname",
            "definition": "A name that is used to address the person in an informal manner, but is not part of their formal or usual name."
        },
        {
            "code": "anonymous",
            "display": "Anonymous",
            "definition": "Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)."
        },
        {
            "code": "old",
            "display": "Old",
            "definition": "This name is no longer in use (or was never correct, but retained for records).",
            "concept":  [
                {
                    "code": "maiden",
                    "display": "Name changed for Marriage",
                    "definition": "A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name."
                }
            ]
        }
    ]
}

Unstructured Names

text

Text representation of the name. This should only be used if a structured name as detailed below cannot be supported. It may be present in addition to a structured name.

Structured Names

Structured names should be used whenever possible as detailed below.

The following elements should be used to construct structured names:

element example
family Smith
given John
prefix Mr
suffix MBE

back to top