FHIR © HL7.org  |  FHIRsmith 0.18.0  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagenictiz.nl.gbb
Resource TypeStructureDefinition
IdStructureDefinition-nl-core-ContactPoint.json
FHIR VersionR4
Sourcehttp://ig.nictiz.nl/gbb/1.0.0-alpha.1/StructureDefinition-nl-core-ContactPoint.html
URLhttp://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint
Version1.0.0-alpha.1
Statusdraft
Date2026-10-09T17:43:13+02:00
NameNlcoreContactPoint
Titlenl core ContactPoint
Realmnl
DescriptionContact information includes a person's telephone numbers and e-mail addresses.
PurposeThis profile is the FHIR implementation of the general building block [ContactPoint](http://ig.nictiz.nl/gbb/ContactPoint).
CopyrightCopyright 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.
TypeContactPoint
Kindcomplex-type

Resources that use this resource

StructureDefinition
nictiz.nl.gbb#1.0.0-alpha.1nl-core-Organizationnl core Organization
nictiz.nl.gbb#1.0.0-alpha.1nl-core-Patientnl core Patient
nictiz.nl.gbb#1.0.0-alpha.1nl-core-Practitionernl core Practitioner
nictiz.nl.gbb#1.0.0-alpha.1nl-core-PractitionerRolenl core PractitionerRole

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source


Dutch


Gegenereerde narrative: StructureDefinition nl-core-ContactPoint

NaamMarkeringenKard.TypeOmschrijving & constraintsdoco
.. ContactPoint 0..*ContactPointTelecomInformation
... system SO1..1codeSystem
VerplichtingenActor
SHALL:populateOntsluitendSysteem
SHALL:handleVerwerkendSysteem
... value SO1..1stringPhoneNumber / EmailAddress
VerplichtingenActor
SHALL:populateOntsluitendSysteem
SHALL:handleVerwerkendSysteem
... use SO0..1codeUse
VerplichtingenActor
SHOULD:populate-if-knownOntsluitendSysteem
SHALL:no-errorVerwerkendSysteem

doco Documentatie voor dit formaat

English


Generated Narrative: StructureDefinition nl-core-ContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint 0..*ContactPointTelecomInformation
... system SO1..1codeSystem
ObligationsActor
SHALL:populateOntsluitendSysteem
SHALL:handleVerwerkendSysteem
... value SO1..1stringPhoneNumber / EmailAddress
ObligationsActor
SHALL:populateOntsluitendSysteem
SHALL:handleVerwerkendSysteem
... use SO0..1codeUse
ObligationsActor
SHOULD:populate-if-knownOntsluitendSysteem
SHALL:no-errorVerwerkendSysteem

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "nl-core-ContactPoint",
  "text": {
    "status": "empty",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://ig.nictiz.nl/gbb/StructureDefinition/nl-core-ContactPoint",
  "version": "1.0.0-alpha.1",
  "name": "NlcoreContactPoint",
  "title": "nl core ContactPoint",
  "status": "draft",
  "date": "2026-10-09T17:43:13+02:00",
  "publisher": "Nictiz",
  "contact": [
    {
      "name": "Nictiz",
      "telecom": [
        {
          "system": "url",
          "value": "https://nictiz.nl"
        }
      ]
    }
  ],
  "description": "Contact information includes a person's telephone numbers and e-mail addresses.",
  "purpose": "This profile is the FHIR implementation of the general building block [ContactPoint](http://ig.nictiz.nl/gbb/ContactPoint).",
  "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.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "requirements-ContactPoint",
      "uri": "http://ig.nictiz.nl/gbb/Requirements/ContactPoint",
      "name": "Information requirements for ContactPoint"
    },
    {
      "identity": "lm-ContactPoint",
      "uri": "http://ig.nictiz.nl/gbb/StructureDefinition/LogicalModelContactPoint",
      "name": "Logical model for ContactPoint"
    },
    {
      "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": "TelecomInformation",
        "definition": "Contact details for telecommunications.",
        "alias": [
          "TelecomInformatie"
        ],
        "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.system",
        "extension": [
          {
            "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.1"
              }
            ],
            "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.1"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "ContactPoint.system",
        "short": "System",
        "definition": "Type of communication form (eg. phone, fax, email)",
        "alias": [
          "Systeem"
        ],
        "min": 1,
        "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"
          }
        ],
        "mustSupport": true,
        "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": "requirements-ContactPoint",
            "map": "CTP-01",
            "comment": "System"
          },
          {
            "identity": "lm-ContactPoint",
            "map": "ContactPoint.system",
            "comment": "Systeem"
          },
          {
            "identity": "v2",
            "map": "XTN.3"
          },
          {
            "identity": "rim",
            "map": "./scheme"
          },
          {
            "identity": "servd",
            "map": "./ContactPointType"
          }
        ]
      },
      {
        "id": "ContactPoint.value",
        "extension": [
          {
            "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.1"
              }
            ],
            "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.1"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "ContactPoint.value",
        "short": "PhoneNumber / EmailAddress",
        "definition": "The actual contact point details (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.",
        "alias": [
          "Telefoonnummer / EmailAdres"
        ],
        "min": 1,
        "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"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "requirements-ContactPoint",
            "map": "CTP-02",
            "comment": "Value"
          },
          {
            "identity": "lm-ContactPoint",
            "map": "ContactPoint.value",
            "comment": "Value"
          },
          {
            "identity": "v2",
            "map": "XTN.1 (or XTN.12)"
          },
          {
            "identity": "rim",
            "map": "./url"
          },
          {
            "identity": "servd",
            "map": "./Value"
          }
        ]
      },
      {
        "id": "ContactPoint.use",
        "extension": [
          {
            "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.1"
              }
            ],
            "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.1"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "ContactPoint.use",
        "short": "Use",
        "definition": "Purpose of the address (eg. home, work)",
        "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.",
        "alias": [
          "Gebruik"
        ],
        "min": 0,
        "max": "1",
        "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"
          }
        ],
        "mustSupport": true,
        "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": "requirements-ContactPoint",
            "map": "CTP-03",
            "comment": "Use"
          },
          {
            "identity": "lm-ContactPoint",
            "map": "ContactPoint.use",
            "comment": "Use"
          },
          {
            "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<TS>\"]"
          },
          {
            "identity": "servd",
            "map": "./StartDate and ./EndDate"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ContactPoint",
        "path": "ContactPoint",
        "short": "TelecomInformation",
        "definition": "Contact details for telecommunications.",
        "alias": [
          "TelecomInformatie"
        ]
      },
      {
        "id": "ContactPoint.system",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "ContactPoint.system",
        "short": "System",
        "definition": "Type of communication form (eg. phone, fax, email)",
        "alias": [
          "Systeem"
        ],
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "requirements-ContactPoint",
            "map": "CTP-01",
            "comment": "System"
          },
          {
            "identity": "lm-ContactPoint",
            "map": "ContactPoint.system",
            "comment": "Systeem"
          }
        ]
      },
      {
        "id": "ContactPoint.value",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "ContactPoint.value",
        "short": "PhoneNumber / EmailAddress",
        "definition": "The actual contact point details (i.e. phone number or email address).",
        "alias": [
          "Telefoonnummer / EmailAdres"
        ],
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "requirements-ContactPoint",
            "map": "CTP-02",
            "comment": "Value"
          },
          {
            "identity": "lm-ContactPoint",
            "map": "ContactPoint.value",
            "comment": "Value"
          }
        ]
      },
      {
        "id": "ContactPoint.use",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "ContactPoint.use",
        "short": "Use",
        "definition": "Purpose of the address (eg. home, work)",
        "alias": [
          "Gebruik"
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "requirements-ContactPoint",
            "map": "CTP-03",
            "comment": "Use"
          },
          {
            "identity": "lm-ContactPoint",
            "map": "ContactPoint.use",
            "comment": "Use"
          }
        ]
      }
    ]
  }
}