{
"description": "Base StructureDefinition for ContactPoint Type",
"_filename": "StructureDefinition-ContactPoint.json",
"requirements": "Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc.",
"package_name": "hl7.fhir.r2.core",
"date": "2015-10-24T07:41:03+11:00",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
},
"publisher": "HL7 FHIR Standard",
"fhirVersion": "1.0.2",
"name": "ContactPoint",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM",
"identity": "rim"
}, {
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD",
"identity": "servd"
} ],
"abstract": false,
"type": null,
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.2",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "cpt-2",
"human": "A system is required if a value is provided.",
"xpath": "not(exists(f:value)) or exists(f:system)",
"severity": "error"
} ],
"path": "ContactPoint",
"min": 0,
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"short": "Details of a Technology mediated contact point (phone, fax, email, etc.)",
"mapping": [ {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
} ],
"type": [ {
"code": "Element"
} ],
"max": "*",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "ContactPoint.id",
"type": [ {
"code": "id"
} ],
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"definition": "unique id for the element within a resource (for internal references).",
"representation": [ "xmlAttr" ]
}, {
"path": "ContactPoint.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*"
}, {
"path": "ContactPoint.system",
"min": 0,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"short": "phone | fax | email | pager | other",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"max": "1",
"condition": [ "cpt-2" ],
"isSummary": true
}, {
"path": "ContactPoint.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"short": "The actual contact point details",
"comments": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"isSummary": true
}, {
"path": "ContactPoint.use",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"definition": "Identifies the purpose for the contact point.",
"isModifier": true,
"short": "home | work | temp | old | mobile - purpose of this contact point",
"comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"max": "1",
"isSummary": true
}, {
"path": "ContactPoint.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"short": "Specify preferred order of use (1 = highest)",
"comments": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "ContactPoint.period",
"type": [ {
"code": "Period"
} ],
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./useablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"isSummary": true,
"definition": "Time period when the contact point was/is in use."
} ]
},
"status": "draft",
"id": "eefcd491-508a-4973-b7a4-22027f8b974f",
"kind": "datatype",
"url": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
"base": "http://hl7.org/fhir/StructureDefinition/Element",
"version": null,
"differential": {
"element": [ {
"constraint": [ {
"key": "cpt-2",
"human": "A system is required if a value is provided.",
"xpath": "not(exists(f:value)) or exists(f:system)",
"severity": "error"
} ],
"path": "ContactPoint",
"min": 0,
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"short": "Details of a Technology mediated contact point (phone, fax, email, etc.)",
"mapping": [ {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
} ],
"type": [ {
"code": "Element"
} ],
"max": "*",
"isSummary": true
}, {
"path": "ContactPoint.system",
"min": 0,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"short": "phone | fax | email | pager | other",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"max": "1",
"condition": [ "cpt-2" ],
"isSummary": true
}, {
"path": "ContactPoint.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"short": "The actual contact point details",
"comments": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"isSummary": true
}, {
"path": "ContactPoint.use",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"definition": "Identifies the purpose for the contact point.",
"isModifier": true,
"short": "home | work | temp | old | mobile - purpose of this contact point",
"comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"max": "1",
"isSummary": true
}, {
"path": "ContactPoint.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"short": "Specify preferred order of use (1 = highest)",
"comments": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "ContactPoint.period",
"type": [ {
"code": "Period"
} ],
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./useablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"isSummary": true,
"definition": "Time period when the contact point was/is in use."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "other"
} ]
} ]
}