Implementation Guide

BaseContactPoint

Base Definition: http://hl7.org/fhir/StructureDefinition/ContactPoint

BaseContactPoint (ContactPoint)	I		ContactPoint	There are no (further) constraints on this element Element id ContactPoint Short description 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. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint
id		0..1	string	There are no (further) constraints on this element Element id ContactPoint.id Short description 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id ContactPoint.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
system	Σ I	1..1	codeBinding	There are no (further) constraints on this element Element id ContactPoint.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	Σ	1..1	string	There are no (further) constraints on this element Element id ContactPoint.value Short description 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). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..0	codeBinding	There are no (further) constraints on this element Element id ContactPoint.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..0	positiveInt	There are no (further) constraints on this element Element id ContactPoint.rank Short description 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. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: n/a
period	Σ I	0..0	Period	There are no (further) constraints on this element Element id ContactPoint.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate

ContactPoint		..
ContactPoint.system		1..
ContactPoint.value		1..
ContactPoint.use		..0
ContactPoint.rank		..0
ContactPoint.period		..0

<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="https://bghmc.org/fhir/StructureDefinition/BaseContactPoint" />
    <name value="BaseContactPoint" />
    <status value="draft" />
    <date value="2023-11-06T04:54:59.1556306+00:00" />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <type value="ContactPoint" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ContactPoint" />
    <derivation value="constraint" />
    <differential>
        <element id="ContactPoint.system">
            <path value="ContactPoint.system" />
            <min value="1" />
        </element>
        <element id="ContactPoint.value">
            <path value="ContactPoint.value" />
            <min value="1" />
        </element>
        <element id="ContactPoint.use">
            <path value="ContactPoint.use" />
            <max value="0" />
        </element>
        <element id="ContactPoint.rank">
            <path value="ContactPoint.rank" />
            <max value="0" />
        </element>
        <element id="ContactPoint.period">
            <path value="ContactPoint.period" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "url": "https://bghmc.org/fhir/StructureDefinition/BaseContactPoint",
    "name": "BaseContactPoint",
    "status": "draft",
    "date": "2023-11-06T04:54:59.1556306+00:00",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "type": "ContactPoint",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ContactPoint.system",
                "path": "ContactPoint.system",
                "min": 1
            },
            {
                "id": "ContactPoint.value",
                "path": "ContactPoint.value",
                "min": 1
            },
            {
                "id": "ContactPoint.use",
                "path": "ContactPoint.use",
                "max": "0"
            },
            {
                "id": "ContactPoint.rank",
                "path": "ContactPoint.rank",
                "max": "0"
            },
            {
                "id": "ContactPoint.period",
                "path": "ContactPoint.period",
                "max": "0"
            }
        ]
    }
}