HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7nz/nzbase/ and changes regularly. See the Directory of published versions

## Data Type Profile: NzContactPoint - JSON Profile

Active as of 2025-12-18

JSON representation of the NzContactPoint data type profile.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "NzContactPoint",
      "text" : {
        "status" : "additional",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">NZ ContactPoint datatype profile</div>"
      },
      "url" : "http://hl7.org.nz/fhir/StructureDefinition/NzContactpoint",
      "version" : "1.0.0",
      "name" : "NzContactPoint",
      "title" : "Common NZ ContactPoint datatype",
      "status" : "active",
      "date" : "2025-12-18T23:25:53+00:00",
      "publisher" : "HL7 New Zealand",
      "contact" : [
        {
          "name" : "HL7 New Zealand",
          "telecom" : [
            {
              "system" : "email",
              "value" : "mailto:admin@hl7.org.nz"
            }
          ]
        }
      ],
      "description" : "This profile adds the Contact Point Purpose and EDI address extensions to the standard data type",
      "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:cp-purpose",
            "path" : "ContactPoint.extension",
            "sliceName" : "cp-purpose",
            "short" : "The business reason this ContactPoint is being used",
            "definition" : "A specific purpose for which this ContactPoint dataType would be used. An example would be to indicate that this ContactPoint is used for video conferencing.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension",
                "profile" : [
                  🔗 "http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose"
                ]
              }
            ],
            "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
          },
          {
            "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" : "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"
              }
            ],
            "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<TS>\"]"
              },
              {
                "identity" : "servd",
                "map" : "./StartDate and ./EndDate"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "ContactPoint",
            "path" : "ContactPoint"
          },
          {
            "id" : "ContactPoint.extension:cp-purpose",
            "path" : "ContactPoint.extension",
            "sliceName" : "cp-purpose",
            "short" : "The business reason this ContactPoint is being used",
            "min" : 0,
            "max" : "1",
            "type" : [
              {
                "code" : "Extension",
                "profile" : [
                  🔗 "http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose"
                ]
              }
            ]
          }
        ]
      }
    }