UK Core Implementation Guide 0.5.0

`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:

Code	Display	Definition
phone	Phone	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.
fax	Fax	The value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.
email	Email	The value is an email address.
pager	Pager	The value is a pager number. These may be local pager numbers that are only usable on a particular pager system.
url	URL	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.
sms	SMS	A contact that can be used for sending an sms message (e.g. mobile phones, some landlines).
other	Other	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.

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:

Code	Display	Definition
home	Home	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.
work	Work	An office contact point. First choice for business related contacts during business hours.
temp	Temp	A temporary contact point. The period can provide more detailed information.
old	Old	This contact point is no longer in use (or was never correct, but retained for records).
mobile	Mobile	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.

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."
        }
    ]
}