FHIR IG Statistics: StructureDefinition/nl-core-contactpoint

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "nl-core-contactpoint",
  "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint",
  "version": "2.0.8",
  "name": "nl-core-contactpoint",
  "title": "nl-core-contactpoint",
  "status": "active",
  "publisher": "HL7 Netherlands",
  "contact": [
    {
      "name": "Nictiz",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nictiz.nl",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for Address Type with additions for Dutch realm addresses. Dutch addresses break down Address.line in several parts and it is important to mark an address as being 'officially registered'.",
  "purpose": "Address information is used for visiting a person or organization and for addressing of mail.",
  "copyright": "CC0",
  "fhirVersion": "3.0.2",
  "mapping": [
    {
      "identity": "hcim-contactinformation-v1.0-2017EN",
      "uri": "https://zibs.nl/wiki/ContactInformation-v1.0(2017EN)",
      "name": "HCIM ContactInformation-v1.0(2017EN)"
    },
    {
      "identity": "hcim-contactinformation-v3.0-2016EN",
      "uri": "https://zibs.nl/wiki/Patient-v3.0(2016EN)",
      "name": "ContactInformation as part of HCIM Patient-v3.0(2016EN)",
      "comment": "ContactInformation has become an independent information model as of release 2017 of the HCIMs"
    },
    {
      "identity": "hcim-contactinformation-v2.0.1-2015EN",
      "uri": "https://zibs.nl/wiki/Patient-v2.0.1(2015EN)",
      "name": "ContactInformation as part of HCIM Patient-v2.0.1(2015EN)",
      "comment": "ContactInformation has become an independent information model as of release 2017 of the HCIMs"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "type": "ContactPoint",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "ContactPoint",
        "path": "ContactPoint",
        "short": "ContactInformation",
        "definition": "Contact information includes a person's telephone numbers and email addresses. This datatype defines a common basis for expressing all contact information around the world, but adds extensions to express Dutch contacts specifically, according to the HCIM ContactInformation (v1.0, 2017). A Dutch ContactPoint still is a proper FHIR ContactPoint, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. The table below explains how the HCIM concepts are mapped to the various FHIR elements. The HCIM code itself should also be included using the TelecomType extension.\r\n\r\n| HCIM                                               | `.ext:TelecomType` | `.system` | `.use`   |\r\n|----------------------------------------------------|:------------------:|:---------:|:--------:|\r\n| Primary Home Land Line                             | _LL_               | _phone_   | _home_   |\r\n| Temporary Land Line                                | _LL_               | _phone_   | _temp_   |\r\n| Primary Work Land Line                             | _LL_               | _phone_   | _work_   |\r\n|                                                    |                    |           |          |\r\n| Primary Home Fax                                   | _FAX_              | _fax_     | _home_   |\r\n| Temporary Fax                                      | _FAX_              | _fax_     | _temp_   |\r\n| Primary Work Fax                                   | _FAX_              | _fax_     | _work_   |\r\n|                                                    |                    |           |          |\r\n| Primary Home Mobile Phone                          | _MC_               | _phone_   | _home_   |\r\n| Temporary Mobile Phone                             | _MC_               | _phone_   | _temp_   |\r\n| Primary Work Mobile Phone                          | _MC_               | _phone_   | _work_   |\r\n|                                                    |                    |           |          |\r\n| Primary Home Pager                                 | _PG_               | _pager_   | _home_   |\r\n| Temporary Pager                                    | _PG_               | _pager_   | _temp_   |\r\n| Primary Work Pager                                 | _PG_               | _pager_   | _work_   |\r\n|                                                    |                    |           |          |\r\n| Private email address                              |                    | _email_   | _home_   |\r\n| Work email address                                 |                    | _email_   | _work_   |\r\n|                                                    |                    |           |          |\r\n| Mobile phone number undetermined private/business  |                    | _phone_   | _mobile_ |",
        "alias": [
          "Contactgegevens"
        ],
        "example": [
          {
            "label": "Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.",
            "valueContactPoint": {
              "system": "phone",
              "value": "+31611234567",
              "use": "work"
            }
          },
          {
            "label": "Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.",
            "valueContactPoint": {
              "system": "phone",
              "value": "+31611234567",
              "use": "mobile"
            }
          },
          {
            "label": "Primary Home Land Line",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
                        "code": "LL",
                        "display": "Land Line"
                      }
                    ]
                  }
                }
              ],
              "system": "phone",
              "value": "...",
              "use": "home"
            }
          },
          {
            "label": "Temporary Land Line",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
                        "code": "LL",
                        "display": "Land Line"
                      }
                    ]
                  }
                }
              ],
              "system": "phone",
              "value": "...",
              "use": "temp"
            }
          },
          {
            "label": "Primary Work Land Line",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
                        "code": "LL",
                        "display": "Land Line"
                      }
                    ]
                  }
                }
              ],
              "system": "phone",
              "value": "...",
              "use": "work"
            }
          },
          {
            "label": "Primary Home Fax",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
                        "code": "FAX",
                        "display": "Fax"
                      }
                    ]
                  }
                }
              ],
              "system": "fax",
              "value": "...",
              "use": "home"
            }
          },
          {
            "label": "Temporary Fax",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
                        "code": "FAX",
                        "display": "Fax"
                      }
                    ]
                  }
                }
              ],
              "system": "fax",
              "value": "...",
              "use": "temp"
            }
          },
          {
            "label": "Primary Work Fax",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
                        "code": "FAX",
                        "display": "Fax"
                      }
                    ]
                  }
                }
              ],
              "system": "fax",
              "value": "...",
              "use": "work"
            }
          },
          {
            "label": "Primary Home Mobile Phone",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/v3/AddressUse",
                        "code": "MC",
                        "display": "Mobile Phone"
                      }
                    ]
                  }
                }
              ],
              "system": "phone",
              "value": "...",
              "use": "home"
            }
          },
          {
            "label": "Temporary Mobile Phone",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/v3/AddressUse",
                        "code": "MC",
                        "display": "Mobile Phone"
                      }
                    ]
                  }
                }
              ],
              "system": "phone",
              "value": "...",
              "use": "temp"
            }
          },
          {
            "label": "Primary Work Mobile Phone",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/v3/AddressUse",
                        "code": "MC",
                        "display": "Mobile Phone"
                      }
                    ]
                  }
                }
              ],
              "system": "phone",
              "value": "...",
              "use": "work"
            }
          },
          {
            "label": "Primary Home Pager",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/v3/AddressUse",
                        "code": "PG",
                        "display": "Pager"
                      }
                    ]
                  }
                }
              ],
              "system": "pager",
              "value": "...",
              "use": "home"
            }
          },
          {
            "label": "Temporary Pager",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/v3/AddressUse",
                        "code": "PG",
                        "display": "Pager"
                      }
                    ]
                  }
                }
              ],
              "system": "pager",
              "value": "...",
              "use": "temp"
            }
          },
          {
            "label": "Primary Work Pager",
            "valueContactPoint": {
              "extension": [
                {
                  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/v3/AddressUse",
                        "code": "PG",
                        "display": "Pager"
                      }
                    ]
                  }
                }
              ],
              "system": "pager",
              "value": "...",
              "use": "work"
            }
          },
          {
            "label": "Private email address",
            "valueContactPoint": {
              "system": "email",
              "value": "giesput@myweb.nl",
              "use": "home"
            }
          },
          {
            "label": "Work email address",
            "valueContactPoint": {
              "system": "email",
              "value": "example@workplace.nl",
              "use": "work"
            }
          }
        ],
        "mapping": [
          {
            "identity": "hcim-contactinformation-v2.0.1-2015EN",
            "map": "NL-CM:0.1.5",
            "comment": "ContactInformation"
          },
          {
            "identity": "hcim-contactinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.5",
            "comment": "ContactInformation"
          },
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.1",
            "comment": "ContactInformation"
          }
        ]
      },
      {
        "id": "ContactPoint.extension",
        "path": "ContactPoint.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 0
      },
      {
        "id": "ContactPoint.extension:TelecomType",
        "path": "ContactPoint.extension",
        "sliceName": "TelecomType",
        "short": "TelecomType",
        "alias": [
          "TelecomType"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"
          }
        ]
      },
      {
        "id": "ContactPoint.extension:TelecomType.valueCodeableConcept:valueCodeableConcept",
        "path": "ContactPoint.extension.valueCodeableConcept",
        "sliceName": "valueCodeableConcept",
        "mapping": [
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.5",
            "comment": "TelecomType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/TelecomTypeCodelijst-to-ContactPointSystem) is available that maps TelecomTypeCodelijst to the ContactPointSystem value set."
          }
        ]
      },
      {
        "id": "ContactPoint.system",
        "path": "ContactPoint.system",
        "short": "TelecomType / EmailAddressType",
        "alias": [
          "TelecomType / EmailSoort"
        ],
        "min": 1,
        "binding": {
          "strength": "required",
          "valueSetReference": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
                "valueReference": {
                  "reference": "http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointSystem",
                  "display": "EmailSoortCodelijst-to-ContactPointSystem"
                }
              },
              {
                "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
                "valueReference": {
                  "reference": "http://nictiz.nl/fhir/ConceptMap/TelecomTypeCodelijst-to-ContactPointSystem",
                  "display": "TelecomTypeCodelijst-to-ContactPointSystem"
                }
              }
            ]
          }
        },
        "mapping": [
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.5",
            "comment": "TelecomType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/TelecomTypeCodelijst-to-ContactPointSystem) is available that maps TelecomTypeCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v2.0.1-2015EN",
            "map": "NL-CM:0.1.19",
            "comment": "EmailAddressType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointSystem) is available that maps EmailSoortCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.19",
            "comment": "EmailAddressType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointSystem) is available that maps EmailSoortCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.8",
            "comment": "EmailAddressType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointSystem) is available that maps EmailSoortCodelijst to the ContactPointUse value set."
          }
        ]
      },
      {
        "id": "ContactPoint.value",
        "path": "ContactPoint.value",
        "short": "TelephoneNumber / EmailAddress",
        "alias": [
          "Telefoonnummer / E-mailadres"
        ],
        "example": [
          {
            "label": "Example TelephoneNumber international",
            "valueString": "+31611234567"
          },
          {
            "label": "Example EmailAddress",
            "valueString": "giesput@myweb.nl"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-contactinformation-v2.0.1-2015EN",
            "map": "NL-CM:0.1.23",
            "comment": "TelephoneNumber"
          },
          {
            "identity": "hcim-contactinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.23",
            "comment": "TelephoneNumber"
          },
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.4",
            "comment": "EmailAddress"
          },
          {
            "identity": "hcim-contactinformation-v2.0.1-2015EN",
            "map": "NL-CM:0.1.20",
            "comment": "EmailAddress"
          },
          {
            "identity": "hcim-contactinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.20",
            "comment": "EmailAddress"
          },
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.7",
            "comment": "EmailAddress"
          }
        ]
      },
      {
        "id": "ContactPoint.use",
        "path": "ContactPoint.use",
        "short": "TelecomType / NumberType / EmailAddressType",
        "definition": "Purpose of this contact point",
        "alias": [
          "TelecomType / NummerSoort / EmailSoort"
        ],
        "binding": {
          "strength": "required",
          "valueSetReference": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
                "valueReference": {
                  "reference": "http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointUse",
                  "display": "EmailSoortCodelijst-to-ContactPointUse"
                }
              },
              {
                "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
                "valueReference": {
                  "reference": "http://nictiz.nl/fhir/ConceptMap/TelecomTypeCodelijst-to-ContactPointUse",
                  "display": "TelecomTypeCodelijst-to-ContactPointUse"
                }
              },
              {
                "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
                "valueReference": {
                  "reference": "http://nictiz.nl/fhir/ConceptMap/NummerSoortCodelijst-to-ContactPointUse",
                  "display": "NummerSoortCodelijst-to-ContactPointUse"
                }
              }
            ]
          }
        },
        "mapping": [
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.5",
            "comment": "TelecomType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/TelecomTypeCodelijst-to-ContactPointUse) is available that maps TelecomTypeCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v2.0.1-2015EN",
            "map": "NL-CM:0.1.22",
            "comment": "NumberType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/NummerSoortCodelijst-to-ContactPointUse) is available that maps NummerSoortCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.22",
            "comment": "NumberType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/NummerSoortCodelijst-to-ContactPointUse) is available that maps NummerSoortCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.6",
            "comment": "NumberType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/NummerSoortCodelijst-to-ContactPointUse) is available that maps NummerSoortCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v2.0.1-2015EN",
            "map": "NL-CM:0.1.19",
            "comment": "EmailAddressType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointUse) is available that maps EmailSoortCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v3.0-2016EN",
            "map": "NL-CM:0.1.19",
            "comment": "EmailAddressType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointUse) is available that maps EmailSoortCodelijst to the ContactPointUse value set."
          },
          {
            "identity": "hcim-contactinformation-v1.0-2017EN",
            "map": "NL-CM:20.6.8",
            "comment": "EmailAddressType. A ConceptMap (http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactPointUse) is available that maps EmailSoortCodelijst to the ContactPointUse value set"
          }
        ]
      }
    ]
  }
}