{ "resourceType": "StructureDefinition", "id": "bc-contactPoint", "text": { "status": "extensions", "div": "

Generated Narrative: StructureDefinition bc-contactPoint

NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"ContactPointContactPoint
\".\"\".\"\".\" Slices for extensionContent/Rules for all slices
\".\"\".\"\".\"\".\"extension:endReasonS0..1CodeableConceptBC End Reason Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension
Binding: BC End Reason Value Set (required)
\".\"\".\"\".\"\".\"extension:ownerS0..1IdentifierBC Owner Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension
\".\"\".\"\".\"\".\"extension:commPurposeExtensionS0..1CodeableConceptBC Communication Purpose Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension
Binding: BC Communication Purpose Value Set (required)
\".\"\".\"\".\"use0..0

\"doco\" Documentation for this format
" }, "url": "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-contactPoint", "version": "1.0.0", "name": "BCContactPoint", "status": "active", "date": "2025-03-06T00:10:12+00:00", "publisher": "BC Ministry of Health", "contact": [ { "name": "BC Ministry of Health", "telecom": [ { "system": "url", "value": "https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries/health" } ] } ], "description": "Adds an end reason and extra contact information.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "CA", "display": "Canada" } ] } ], "fhirVersion": "4.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" } ], "kind": "complex-type", "abstract": false, "type": "ContactPoint", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ContactPoint", "derivation": "constraint", "snapshot": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "4.0.1" } ], "element": [ { "id": "ContactPoint", "path": "ContactPoint", "short": "Details of a Technology mediated contact point (phone, fax, email, etc.)", "definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.", "min": 0, "max": "*", "base": { "path": "ContactPoint", "min": 0, "max": "*" }, "condition": [ "ele-1" ], "constraint": [ { "key": "cpt-2", "severity": "error", "human": "A system is required if a value is provided.", "expression": "value.empty() or system.exists()", "xpath": "not(exists(f:value)) or exists(f:system)", "source": "http://hl7.org/fhir/StructureDefinition/ContactPoint" }, { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XTN" }, { "identity": "rim", "map": "TEL" }, { "identity": "servd", "map": "ContactPoint" } ] }, { "id": "ContactPoint.id", "path": "ContactPoint.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ContactPoint.extension", "path": "ContactPoint.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ContactPoint.extension:endReason", "path": "ContactPoint.extension", "sliceName": "endReason", "short": "BC End Reason Extension", "definition": "Tracking end reason.", "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": true, "isModifier": false, "isSummary": false }, { "id": "ContactPoint.extension:owner", "path": "ContactPoint.extension", "sliceName": "owner", "short": "BC Owner Extension", "definition": "Tracking the owner.", "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": true, "isModifier": false, "isSummary": false }, { "id": "ContactPoint.extension:commPurposeExtension", "path": "ContactPoint.extension", "sliceName": "commPurposeExtension", "short": "BC Communication Purpose Extension", "definition": "BC extension for communication purpose codes.", "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": true, "isModifier": false, "isSummary": false }, { "id": "ContactPoint.system", "path": "ContactPoint.system", "short": "phone | fax | email | pager | url | sms | other", "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "min": 0, "max": "1", "base": { "path": "ContactPoint.system", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cpt-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointSystem" } ], "strength": "required", "description": "Telecommunications form for contact point.", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" }, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ] }, { "id": "ContactPoint.value", "path": "ContactPoint.value", "short": "The actual contact point details", "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "min": 0, "max": "1", "base": { "path": "ContactPoint.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ] }, { "id": "ContactPoint.use", "path": "ContactPoint.use", "short": "home | work | temp | old | mobile - purpose of this contact point", "definition": "Identifies the purpose for the contact point.", "comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "min": 0, "max": "0", "base": { "path": "ContactPoint.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "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, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointUse" } ], "strength": "required", "description": "Use of contact point.", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" }, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ] }, { "id": "ContactPoint.rank", "path": "ContactPoint.rank", "short": "Specify preferred order of use (1 = highest)", "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.", "comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "min": 0, "max": "1", "base": { "path": "ContactPoint.rank", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "ContactPoint.period", "path": "ContactPoint.period", "short": "Time period when the contact point was/is in use", "definition": "Time period when the contact point was/is in use.", "min": 0, "max": "1", "base": { "path": "ContactPoint.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] }, "differential": { "element": [ { "id": "ContactPoint.extension:endReason", "path": "ContactPoint.extension", "sliceName": "endReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension" ] } ], "mustSupport": true }, { "id": "ContactPoint.extension:owner", "path": "ContactPoint.extension", "sliceName": "owner", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension" ] } ], "mustSupport": true }, { "id": "ContactPoint.extension:commPurposeExtension", "path": "ContactPoint.extension", "sliceName": "commPurposeExtension", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension" ] } ], "mustSupport": true }, { "id": "ContactPoint.use", "path": "ContactPoint.use", "max": "0" } ] } }