{
"description": "Contact information includes a person's telephone numbers and e-mail addresses.",
"_filename": "StructureDefinition-nl-core-ContactPoint.json",
"package_name": "nictiz.nl.gbb",
"date": "2026-10-26T15:40:52+01:00",
"derivation": "constraint",
"publisher": "Nictiz",
"fhirVersion": "4.0.1",
"purpose": "This profile is the FHIR implementation of the general building block [ContactPoint](http://ig.nictiz.nl/gbb/ContactPoint).",
"name": "NlcoreContactPoint",
"mapping": [ {
"uri": "http://ig.nictiz.nl/gbb/Requirements/ContactPoint",
"name": "Information requirements for ContactPoint",
"identity": "requirements-ContactPoint"
}, {
"uri": "http://ig.nictiz.nl/gbb/StructureDefinition/LogicalModelContactPoint",
"name": "Logical model for ContactPoint",
"identity": "lm-ContactPoint"
}, {
"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": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"type": "ContactPoint",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "nl core ContactPoint",
"package_version": "1.0.0-alpha.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)",
"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": "Contact details for telecommunications.",
"isModifier": false,
"short": "TelecomInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
} ],
"alias": [ "TelecomInformatie" ],
"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",
"min": 1,
"definition": "Type of communication form (eg. phone, fax, email)",
"isModifier": false,
"short": "System",
"mapping": [ {
"map": "CTP-01",
"comment": "System",
"identity": "requirements-ContactPoint"
}, {
"map": "ContactPoint.system",
"comment": "Systeem",
"identity": "lm-ContactPoint"
}, {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:populate"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ExchangingSystem"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint|1.0.0-alpha.2"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:handle"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ConsumingSystem"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint|1.0.0-alpha.2"
} ]
} ],
"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."
},
"alias": [ "Systeem" ],
"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 (i.e. phone number or email address).",
"isModifier": false,
"short": "PhoneNumber / EmailAddress",
"mapping": [ {
"map": "CTP-02",
"comment": "Value",
"identity": "requirements-ContactPoint"
}, {
"map": "ContactPoint.value",
"comment": "Value",
"identity": "lm-ContactPoint"
}, {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:populate"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ExchangingSystem"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint|1.0.0-alpha.2"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:handle"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ConsumingSystem"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint|1.0.0-alpha.2"
} ]
} ],
"alias": [ "Telefoonnummer / EmailAdres" ],
"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": "Purpose of the address (eg. home, work)",
"isModifier": true,
"short": "Use",
"mapping": [ {
"map": "CTP-03",
"comment": "Use",
"identity": "requirements-ContactPoint"
}, {
"map": "ContactPoint.use",
"comment": "Use",
"identity": "lm-ContactPoint"
}, {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHOULD:populate-if-known"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ExchangingSystem"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint|1.0.0-alpha.2"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:no-error"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ConsumingSystem"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint|1.0.0-alpha.2"
} ]
} ],
"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."
},
"alias": [ "Gebruik" ],
"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
}, {
"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"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "ContactPoint.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
} ]
},
"status": "draft",
"id": "32558313-0844-401d-ad9b-bd18ad077641",
"kind": "complex-type",
"url": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint",
"version": "1.0.0-alpha.2",
"differential": {
"element": [ {
"id": "ContactPoint",
"path": "ContactPoint",
"alias": [ "TelecomInformatie" ],
"short": "TelecomInformation",
"definition": "Contact details for telecommunications."
}, {
"path": "ContactPoint.system",
"min": 1,
"definition": "Type of communication form (eg. phone, fax, email)",
"short": "System",
"mapping": [ {
"map": "CTP-01",
"comment": "System",
"identity": "requirements-ContactPoint"
}, {
"map": "ContactPoint.system",
"comment": "Systeem",
"identity": "lm-ContactPoint"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:populate"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ExchangingSystem"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:handle"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ConsumingSystem"
} ]
} ],
"alias": [ "Systeem" ],
"id": "ContactPoint.system"
}, {
"path": "ContactPoint.value",
"min": 1,
"definition": "The actual contact point details (i.e. phone number or email address).",
"short": "PhoneNumber / EmailAddress",
"mapping": [ {
"map": "CTP-02",
"comment": "Value",
"identity": "requirements-ContactPoint"
}, {
"map": "ContactPoint.value",
"comment": "Value",
"identity": "lm-ContactPoint"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:populate"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ExchangingSystem"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:handle"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ConsumingSystem"
} ]
} ],
"alias": [ "Telefoonnummer / EmailAdres" ],
"id": "ContactPoint.value"
}, {
"id": "ContactPoint.use",
"path": "ContactPoint.use",
"alias": [ "Gebruik" ],
"short": "Use",
"mapping": [ {
"map": "CTP-03",
"comment": "Use",
"identity": "requirements-ContactPoint"
}, {
"map": "ContactPoint.use",
"comment": "Use",
"identity": "lm-ContactPoint"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHOULD:populate-if-known"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ExchangingSystem"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:no-error"
}, {
"url": "actor",
"valueCanonical": "http://ig.nictiz.nl/gbb/ActorDefinition/ConsumingSystem"
} ]
} ],
"definition": "Purpose of the address (eg. home, work)",
"mustSupport": true
} ]
},
"contact": [ {
"name": "Nictiz",
"telecom": [ {
"value": "https://nictiz.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ContactPoint"
}