{
"description": "Phone number as contact point of a person or organization according to eCH-0046",
"_filename": "StructureDefinition-ch-core-contactpoint-ech-46-phone.json",
"package_name": "ch.fhir.ig.ch-core",
"date": "2024-05-16T16:08:37+00:00",
"derivation": "constraint",
"publisher": "HL7 Switzerland",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "CH",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "CHCoreContactPointECH46Phone",
"mapping": [ {
"uri": "https://www.ech.ch/",
"name": "eCH Standards",
"identity": "eCH"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD",
"identity": "servd"
} ],
"abstract": false,
"copyright": "CC0-1.0",
"type": "ContactPoint",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "CH Core ContactPoint eCH-0046 Phone",
"package_version": "5.0.0-ballot",
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
"severity": "error",
"expression": "value.empty() or system.exists()"
}, {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint",
"min": 0,
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"isModifier": false,
"short": "CH Core ContactPoint eCH-0046 Phone",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
}, {
"map": "eCH-0046: phone",
"identity": "eCH"
} ],
"max": "*",
"id": "ContactPoint",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "ContactPoint"
}
}, {
"path": "ContactPoint.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ContactPoint.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ContactPoint.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ContactPoint.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.system",
"fixedCode": "phone",
"min": 1,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"isModifier": false,
"short": "phone | fax | email | pager | url | sms | other",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
}, {
"map": "eCH-0046: phoneType",
"identity": "eCH"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
} ],
"description": "Telecommunications form for contact point."
},
"max": "1",
"id": "ContactPoint.system",
"condition": [ "cpt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 1,
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"isModifier": false,
"short": "The actual contact point details",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "eCH-0046: phoneNumber",
"identity": "eCH"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ContactPoint.value",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
}, {
"map": "eCH-0046: phoneCategory/otherPhoneCategory",
"identity": "eCH"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
} ],
"description": "Use of contact point."
},
"max": "1",
"id": "ContactPoint.use",
"comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true
}, {
"path": "ContactPoint.use.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ContactPoint.use.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ContactPoint.use.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "ContactPoint.use.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ContactPoint.use.extension",
"min": 0,
"definition": "Optional Extension Element - found in all resources.",
"isModifier": false,
"short": "Optional Extensions Element",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "eCH-0046: phoneNumberCategory",
"identity": "eCH"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory" ]
} ],
"sliceName": "phoneCategory",
"max": "1",
"id": "ContactPoint.use.extension:phoneCategory",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ContactPoint.use.value",
"min": 0,
"definition": "Primitive value for code",
"isModifier": false,
"short": "Primitive value for code",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[^\\s]+(\\s[^\\s]+)*"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ContactPoint.use.value",
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.rank",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Specify preferred order of use (1 = highest)",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "ContactPoint.rank",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.rank"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.period",
"min": 0,
"definition": "Time period when the contact point was/is in use.",
"isModifier": false,
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
}, {
"map": "eCH-0046: validity",
"identity": "eCH"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "ContactPoint.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
}, {
"path": "ContactPoint.period.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ContactPoint.period.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ContactPoint.period.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ContactPoint.period.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.period.start",
"min": 0,
"definition": "The start of the period. The boundary is inclusive.",
"isModifier": false,
"short": "Starting time with inclusive boundary",
"mapping": [ {
"map": "DR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
}, {
"map": "eCH-0046: dateFrom",
"identity": "eCH"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "ContactPoint.period.start",
"condition": [ "per-1" ],
"comment": "If the low element is missing, the meaning is that the low boundary is not known.",
"base": {
"max": "1",
"min": 0,
"path": "Period.start"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.period.end",
"min": 0,
"definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"isModifier": false,
"short": "End time with inclusive boundary, if not ongoing",
"mapping": [ {
"map": "DR.2",
"identity": "v2"
}, {
"map": "./high",
"identity": "rim"
}, {
"map": "eCH-0046: dateTo",
"identity": "eCH"
} ],
"type": [ {
"code": "dateTime"
} ],
"meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
"max": "1",
"id": "ContactPoint.period.end",
"condition": [ "per-1" ],
"comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
"base": {
"max": "1",
"min": 0,
"path": "Period.end"
},
"isSummary": true
} ]
},
"status": "active",
"id": "6a5c4d7a-c2df-4731-8b07-ce712d139508",
"kind": "complex-type",
"url": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-contactpoint-ech-46-phone",
"version": "5.0.0-ballot",
"differential": {
"element": [ {
"id": "ContactPoint",
"path": "ContactPoint",
"short": "CH Core ContactPoint eCH-0046 Phone",
"mapping": [ {
"map": "eCH-0046: phone",
"identity": "eCH"
} ]
}, {
"id": "ContactPoint.system",
"min": 1,
"path": "ContactPoint.system",
"mapping": [ {
"map": "eCH-0046: phoneType",
"identity": "eCH"
} ],
"fixedCode": "phone"
}, {
"id": "ContactPoint.value",
"min": 1,
"path": "ContactPoint.value",
"mapping": [ {
"map": "eCH-0046: phoneNumber",
"identity": "eCH"
} ]
}, {
"id": "ContactPoint.use",
"path": "ContactPoint.use",
"mapping": [ {
"map": "eCH-0046: phoneCategory/otherPhoneCategory",
"identity": "eCH"
} ]
}, {
"id": "ContactPoint.use.extension",
"path": "ContactPoint.use.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "ContactPoint.use.extension:phoneCategory",
"max": "1",
"min": 0,
"path": "ContactPoint.use.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory" ]
} ],
"mapping": [ {
"map": "eCH-0046: phoneNumberCategory",
"identity": "eCH"
} ],
"sliceName": "phoneCategory"
}, {
"id": "ContactPoint.period",
"path": "ContactPoint.period",
"mapping": [ {
"map": "eCH-0046: validity",
"identity": "eCH"
} ]
}, {
"id": "ContactPoint.period.start",
"path": "ContactPoint.period.start",
"mapping": [ {
"map": "eCH-0046: dateFrom",
"identity": "eCH"
} ]
}, {
"id": "ContactPoint.period.end",
"path": "ContactPoint.period.end",
"mapping": [ {
"map": "eCH-0046: dateTo",
"identity": "eCH"
} ]
} ]
},
"contact": [ {
"name": "HL7 Switzerland",
"telecom": [ {
"value": "https://www.hl7.ch/",
"system": "url"
} ]
}, {
"name": "HL7 Switzerland",
"telecom": [ {
"use": "work",
"value": "https://www.hl7.ch/",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ContactPoint"
}