Release 5
FoundationThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw Turtle (+ also see Turtle/RDF Format Specification)
StructureDefinition for ContactPoint
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
# - resource -------------------------------------------------------------------
[] a fhir:StructureDefinition ;
fhir:id [ fhir:v "ContactPoint"] ;
fhir:text [
fhir:status [ fhir:v "generated" ]
] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "normative" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ;
fhir:value [ fhir:v "4.0.0" ]
] ) ;
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/ContactPoint"], [ fhir:v "http://hl7.org/fhir/StructureDefinition/ContactPoint"] ;
fhir:version [ fhir:v "5.0.0"], [ fhir:v "5.0.0"] ;
fhir:name [ fhir:v "ContactPoint"], [ fhir:v "ContactPoint"] ;
fhir:status [ fhir:v "active"], [ fhir:v "active"] ;
fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
fhir:date [ fhir:v "2023-03-26T15:21:02+11:00"], [ fhir:v "2023-03-26T15:21:02+11:00"] ;
fhir:publisher [ fhir:v "HL7 FHIR Standard"], [ fhir:v "HL7 FHIR Standard"] ;
fhir:contact ( [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] )
] ) ;
fhir:description [ fhir:v "ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc."], [ fhir:v "ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc."] ;
fhir:jurisdiction ( [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] ) ;
fhir:purpose [ fhir:v "Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc."], [ fhir:v "Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc."] ;
fhir:fhirVersion [ fhir:v "5.0.0"] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:uri [ fhir:v "http://hl7.org/v2" ] ;
fhir:name [ fhir:v "HL7 V2 Mapping" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:uri [ fhir:v "http://hl7.org/v3" ] ;
fhir:name [ fhir:v "RIM Mapping" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:uri [ fhir:v "http://www.omg.org/spec/ServD/1.0/" ] ;
fhir:name [ fhir:v "ServD" ]
] ) ;
fhir:kind [ fhir:v "complex-type"] ;
fhir:abstract [ fhir:v "false"] ;
fhir:type [ fhir:v "ContactPoint"] ;
fhir:baseDefinition [ fhir:v "http://hl7.org/fhir/StructureDefinition/DataType"] ;
fhir:derivation [ fhir:v "specialization"] ;
fhir:snapshot [
fhir:element ( [
fhir:id [ fhir:v "ContactPoint" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "normative" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ;
fhir:value [ fhir:v "4.0.0" ]
] ) ;
fhir:path [ fhir:v "ContactPoint" ] ;
fhir:short [ fhir:v "Details of a Technology mediated contact point (phone, fax, email, etc.)" ] ;
fhir:definition [ fhir:v "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "ContactPoint" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:constraint ( [
fhir:key [ fhir:v "cpt-2" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "A system is required if a value is provided." ] ;
fhir:expression [ fhir:v "value.empty() or system.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/ContactPoint" ]
] [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a,TEL" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "ContactPoint" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.id" ] ;
fhir:path [ fhir:v "ContactPoint.id" ] ;
fhir:representation ( [ fhir:v "xmlAttr" ] ) ;
fhir:short [ fhir:v "Unique id for inter-element referencing" ] ;
fhir:definition [ fhir:v "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Element.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "id" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:condition ( [ fhir:v "ele-1" ] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.extension" ] ;
fhir:path [ fhir:v "ContactPoint.extension" ] ;
fhir:slicing [
fhir:discriminator ( [
fhir:type [ fhir:v "value" ] ;
fhir:path [ fhir:v "url" ]
] ) ;
fhir:description [ fhir:v "Extensions are always sliced by (at least) url" ] ;
fhir:rules [ fhir:v "open" ]
] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." ] ;
fhir:comment [ fhir:v "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Element.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] [
fhir:key [ fhir:v "ext-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "Must have either extensions or value[x], not both" ] ;
fhir:expression [ fhir:v "extension.exists() != value.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Extension" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.system" ] ;
fhir:path [ fhir:v "ContactPoint.system" ] ;
fhir:short [ fhir:v "phone | fax | email | pager | url | sms | other" ] ;
fhir:definition [ fhir:v "Telecommunications form for contact point - what communications system is required to make use of the contact." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "ContactPoint.system" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:condition ( [ fhir:v "cpt-2" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "Telecommunications form for contact point." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ContactPointSystem" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "Telecommunications form for contact point." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN.3" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./scheme" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./ContactPointType" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.value" ] ;
fhir:path [ fhir:v "ContactPoint.value" ] ;
fhir:short [ fhir:v "The actual contact point details" ] ;
fhir:definition [ fhir:v "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)." ] ;
fhir:comment [ fhir:v "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value." ] ;
fhir:requirements [ fhir:v "Need to support legacy numbers that are not in a tightly controlled format." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "ContactPoint.value" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:condition ( [ fhir:v "cpt-2" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN.1 (or XTN.12)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./url" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Value" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.use" ] ;
fhir:path [ fhir:v "ContactPoint.use" ] ;
fhir:short [ fhir:v "home | work | temp | old | mobile - purpose of this contact point" ] ;
fhir:definition [ fhir:v "Identifies the purpose for the contact point." ] ;
fhir:comment [ fhir:v "Applications can assume that a contact is current unless it explicitly says that it is temporary or old." ] ;
fhir:requirements [ fhir:v "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "ContactPoint.use" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "Use of contact point." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ContactPointUse" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "Use of contact point." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN.2 - but often indicated by field" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./use)" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./ContactPointPurpose" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.rank" ] ;
fhir:path [ fhir:v "ContactPoint.rank" ] ;
fhir:short [ fhir:v "Specify preferred order of use (1 = highest)" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.\n\nRanks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean \"X is my most preferred phone number, Y is my most preferred email address\" or \"X is my preferred home email and Y is my preferred work email\". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. \n\nRanks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "ContactPoint.rank" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "positiveInt" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "n/a" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.period" ] ;
fhir:path [ fhir:v "ContactPoint.period" ] ;
fhir:short [ fhir:v "Time period when the contact point was/is in use" ] ;
fhir:definition [ fhir:v "Time period when the contact point was/is in use." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "ContactPoint.period" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Period" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "N/A" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./usablePeriod[type=\"IVL<TS>\"]" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./StartDate and ./EndDate" ]
] )
] )
] ;
fhir:differential [
fhir:element ( [
fhir:id [ fhir:v "ContactPoint" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "normative" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ;
fhir:value [ fhir:v "4.0.0" ]
] ) ;
fhir:path [ fhir:v "ContactPoint" ] ;
fhir:short [ fhir:v "Details of a Technology mediated contact point (phone, fax, email, etc.)" ] ;
fhir:definition [ fhir:v "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:constraint ( [
fhir:key [ fhir:v "cpt-2" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "A system is required if a value is provided." ] ;
fhir:expression [ fhir:v "value.empty() or system.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/ContactPoint" ]
] ) ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "TEL" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "ContactPoint" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.system" ] ;
fhir:path [ fhir:v "ContactPoint.system" ] ;
fhir:short [ fhir:v "phone | fax | email | pager | url | sms | other" ] ;
fhir:definition [ fhir:v "Telecommunications form for contact point - what communications system is required to make use of the contact." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:condition ( [ fhir:v "cpt-2" ] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "Telecommunications form for contact point." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ContactPointSystem" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "Telecommunications form for contact point." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN.3" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./scheme" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./ContactPointType" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.value" ] ;
fhir:path [ fhir:v "ContactPoint.value" ] ;
fhir:short [ fhir:v "The actual contact point details" ] ;
fhir:definition [ fhir:v "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)." ] ;
fhir:comment [ fhir:v "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value." ] ;
fhir:requirements [ fhir:v "Need to support legacy numbers that are not in a tightly controlled format." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:condition ( [ fhir:v "cpt-2" ] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN.1 (or XTN.12)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./url" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Value" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.use" ] ;
fhir:path [ fhir:v "ContactPoint.use" ] ;
fhir:short [ fhir:v "home | work | temp | old | mobile - purpose of this contact point" ] ;
fhir:definition [ fhir:v "Identifies the purpose for the contact point." ] ;
fhir:comment [ fhir:v "Applications can assume that a contact is current unless it explicitly says that it is temporary or old." ] ;
fhir:requirements [ fhir:v "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "Use of contact point." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ContactPointUse" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "Use of contact point." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XTN.2 - but often indicated by field" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./use)" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./ContactPointPurpose" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.rank" ] ;
fhir:path [ fhir:v "ContactPoint.rank" ] ;
fhir:short [ fhir:v "Specify preferred order of use (1 = highest)" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.\n\nRanks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean \"X is my most preferred phone number, Y is my most preferred email address\" or \"X is my preferred home email and Y is my preferred work email\". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. \n\nRanks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "positiveInt" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "n/a" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "ContactPoint.period" ] ;
fhir:path [ fhir:v "ContactPoint.period" ] ;
fhir:short [ fhir:v "Time period when the contact point was/is in use" ] ;
fhir:definition [ fhir:v "Time period when the contact point was/is in use." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Period" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "N/A" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./usablePeriod[type=\"IVL<TS>\"]" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./StartDate and ./EndDate" ]
] )
] )
] .
# -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:23+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change