Patient-BNet-Preg

FHIR Resource information

FHIR Resource	🌍Patient-BNet-Preg. Based on 🌍 patient
Description	Single pregnancy demographics of woman.
Release status	LIVE
Cardinality	Single Instance
Writing to Spine permitted	YES - for Spine Client Type (MAT, NNU) When sending data into the Spine, we accept either a UKPatient, or NZPatient FHIR resource: UK: HL7 FHIR® UK Core R4 NZ: FHIR NZ Base project Depending on what has been submitted, the Spine maps different items to BadgerNet. When reading from the Spine, either the UKPatient or NZPatient resource will be used depending on the country of the Spine Platform.
Spine filters	NZMAT-HISO

Key FHIR Resource elements used

id - Logical ID for the patient

Summary	Logical ID for the patient
Mandatory	No
Expected type	🌍string
Write allowed	No
Data Dictionary item	None

identifier.coding.code - Patient's current NHI or NHS number format

Summary	Patient's current NHI or NHS number format
Description	The NHI/NHS number, EDD and DOB must be unique for each pregnancy. Hence, when the NHI/NHS number is updated, the Spine will verify whether the new NHI/NHS number, EDD and DOB exists. If it does, a HTTP 409 conflict error will be returned.
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.NationalID - Mother's current national ID NHS/NHI/CHI - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

name.prefix - Patient's title (prefix)

Summary	Patient's title (prefix)
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.name.prefix - Mother's title (prefix) - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - Topic: (MatDemographics) Demographics of woman

name.given - Patient's given name(s)

Summary	Patient's given name(s)
Description	Woman/pregnant person's given name(s) provided as an array.
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.name.given - Mother's given name - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

name.family - Patient's surname

Summary	Patient's surname
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.name.family - Mother's surname - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

name.suffix - Patient name suffix

Summary	Patient name suffix
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.name.suffix - Mother name suffix - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - Topic: (MatDemographics) Demographics of woman

name.use - Identifies the purpose for this name.

Summary	Identifies the purpose for this name.
Description	This item defines the type of name provided. This item should be either "official" or "usual".
Mandatory	No
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	Mat.name.use - Preferred name indicator - Topic: (MatDemographics) Demographics of woman

dateOfBirth - Patient identity Date of birth

Summary	Patient identity Date of birth
Mandatory	No
Expected type	🌍date
Write allowed	Yes
Data Dictionary item	Mat.dateOfBirth - Mother identity Date of birth - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

extension:patientEthnicities - Wrapper element for patient's ethnicities. The URL for this extension is https://clevermed.com/fhir/StructureDefinition/Patient-BNet-Preg-Ethnicities

Summary	Wrapper element for patient's ethnicities. The URL for this extension is https://clevermed.com/fhir/StructureDefinition/Patient-BNet-Preg-Ethnicities
Mandatory	No
Expected type	🌍Extension(Complex)
Write allowed	Yes
Data Dictionary item	None

extension(patient-ethnicities).extension:ethnicity - Patient identity Ethnicity. The URL for this extension is http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity.

Summary	Patient identity Ethnicity. The URL for this extension is http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity.
Description	Up to six values of ethnicity can be recorded. This is accomplished by repeating this element for each applicable ethnicity. When updating a patient resource, a client must send all applicable ethnicities.
Mandatory	No
Expected type	🌍extension
Write allowed	Yes
Data Dictionary item	Mat.extension(Mat-ethnicity) - Mother identity Ethnicity - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - Topic: (MatDemographics) Demographics of woman

gender - Gender of patient

Summary	Gender of patient
Mandatory	No
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	None

address.extension - Patient's building name of residence

Summary	Patient's building name of residence
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.address.extension - Mother's building name of residence - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

address.extension:buldingName - Patient's building name of residence. The extension URL is: http://hl7.org.nz/fhir/StructureDefinition/building-name.

Summary	Patient's building name of residence. The extension URL is: http://hl7.org.nz/fhir/StructureDefinition/building-name.
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.address.extension - Mother's building name of residence - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

address.extension:suburb - Address' suburb. The extension URL is: https://hl7.org.nz/fhir/StructureDefinition/suburb.

Summary	Address' suburb. The extension URL is: https://hl7.org.nz/fhir/StructureDefinition/suburb.
Mandatory	No
Expected type	🌍extension
Write allowed	Yes
Data Dictionary item	None

address.use - The purpose of this address.

Summary	The purpose of this address.
Mandatory	No
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	None
Fixed value	Fixed code value of 'home' should be used.

address.line - Patient address of residence

Summary	Patient address of residence
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.address.line - Mother address of residence - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

address.city - Patient city/town of residence

Summary	Patient city/town of residence
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.address.city - Mother city/town of residence - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

address.postCode - Patient address Postcode (zip/postal code)

Summary	Patient address Postcode (zip/postal code)
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.address.postCode - Mother address Postcode (zip/postal code) - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

address.country - Patient address Country code

Summary	Patient address Country code
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.address.country - Mother address Country code - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

Language - Patient language

Summary	Patient language
Mandatory	No
Expected type	🌍CodeableConcept
Write allowed	Yes
Data Dictionary item	Mat.Language - Mother language - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - Topic: (MatDemographics) Demographics of woman
Value set used	🌍ValueSet-BNet-Patient-Languages

EmergencyContact.name.use - First emergency contact's preferred name indicator.

Summary	First emergency contact's preferred name indicator.
Description	This is an optional element.
Mandatory	No
Expected type	🌍CodableConcept
Write allowed	Yes
Data Dictionary item	EmergencyContact.name.use - Emergency contact's preferred name indicatoore - Topic: (MatDemographics) Demographics of woman

EmergencyContact.name.family - First emergency contact's surname

Summary	First emergency contact's surname
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.name.family - Emergency contact's surname - Topic: (MatDemographics) Demographics of woman

EmergencyContact.name.given - First emergency contact's given name

Summary	First emergency contact's given name
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.name.given - Emergency contact's given name - Topic: (MatDemographics) Demographics of woman

EmergencyContact.AddressLine - First emergency contact's lines of address

Summary	First emergency contact's lines of address
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.AddressLine - Emergency contact's lines of address - Topic: (MatDemographics) Demographics of woman

EmergencyContact.City - First emergency contact's city or town of residence

Summary	First emergency contact's city or town of residence
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.City - Emergency contact's city or town of residence - Topic: (MatDemographics) Demographics of woman

EmergencyContact.postCode - First emergency contact's postcode

Summary	First emergency contact's postcode
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.postCode - Emergency contact's postcode - Topic: (MatDemographics) Demographics of woman

EmergencyContact.Telecom.Home - First emergency contact's home telephone number

Summary	First emergency contact's home telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.Telecom.Home - Emergency contact's home telephone number - Topic: (MatDemographics) Demographics of woman

EmergencyContact.Telecom.Work - First emergency contact's work telephone number

Summary	First emergency contact's work telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.Telecom.Work - Emergency contact's work telephone number - Topic: (MatDemographics) Demographics of woman

EmergencyContact.Telecom.Mobile - First emergency contact's mobile telephone number

Summary	First emergency contact's mobile telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.Telecom.Mobile - Emergency contact's mobile telephone number - Topic: (MatDemographics) Demographics of woman

EmergencyContact.Telecom.Email - First emergency contact's email address

Summary	First emergency contact's email address
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	EmergencyContact.Telecom.Email - Emergency contact's email address - Topic: (MatDemographics) Demographics of woman

EmergencyContact.name.use - Second emergency contact's preferred name indicator.

Summary	Second emergency contact's preferred name indicator.
Description	This is an optional element.
Mandatory	No
Expected type	🌍CodableConcept
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.name.family - Second emergency contact's surname

Summary	Second emergency contact's surname
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.name.given - Second emergency contact's given name

Summary	Second emergency contact's given name
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.AddressLine - Second emergency contact's lines of address

Summary	Second emergency contact's lines of address
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.City - Second emergency contact's city or town of residence

Summary	Second emergency contact's city or town of residence
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.postCode - Second emergency contact's postcode

Summary	Second emergency contact's postcode
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.Telecom.Home - Second emergency contact's home telephone number

Summary	Second emergency contact's home telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.Telecom.Work - Second emergency contact's work telephone number

Summary	Second emergency contact's work telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.Telecom.Mobile - Second emergency contact's mobile telephone number

Summary	Second emergency contact's mobile telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

EmergencyContact.Telecom.Email - Second emergency contact's email address

Summary	Second emergency contact's email address
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	None

NextofKin.name.use - Next of kin's preferred name indicator.

Summary	Next of kin's preferred name indicator.
Description	This is an optional element.
Mandatory	No
Expected type	🌍CodableConcept
Write allowed	Yes
Data Dictionary item	NextofKin.name.use - Next of kin's preferred name indicatoore - Topic: (MatDemographics) Demographics of woman

NextofKin.name.family - Next of kin's surname

Summary	Next of kin's surname
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.name.family - Next of kin's surname - Topic: (MatDemographics) Demographics of woman

NextofKin.name.given - Next of kin's given name

Summary	Next of kin's given name
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.name.given - Next of kin's given name - Topic: (MatDemographics) Demographics of woman

NextofKin.AddressLine - Next of kin's address lines

Summary	Next of kin's address lines
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.AddressLine - Next of kin's address lines - Topic: (MatDemographics) Demographics of woman

NextofKin.City - Next of kin's city of residence

Summary	Next of kin's city of residence
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.City - Next of kin's city of residence - Topic: (MatDemographics) Demographics of woman

NextofKin.postCode - Next of kin's postcode

Summary	Next of kin's postcode
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.postCode - Next of kin's postcode - Topic: (MatDemographics) Demographics of woman

NextofKin.Telecom.Home - Next of kin's home telephone number

Summary	Next of kin's home telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.Telecom.Home - Next of kin's home telephone number - Topic: (MatDemographics) Demographics of woman

NextofKin.Telecome.Work - Next of kin's work telephone number

Summary	Next of kin's work telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.Telecome.Work - Next of kin's work telephone number - Topic: (MatDemographics) Demographics of woman

NextofKin.Telecom.Mobile - Next of kin's work mobile number

Summary	Next of kin's work mobile number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.Telecom.Mobile - Next of kin's work mobile number - Topic: (MatDemographics) Demographics of woman

NextofKin.Telecom.Email - Next of kin's email address

Summary	Next of kin's email address
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	NextofKin.Telecom.Email - Next of kin's email address - Topic: (MatDemographics) Demographics of woman

Telecom.Home - Patient's home telephone number

Summary	Patient's home telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.Telecom.Home - Mother's home telephone number - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - Topic: (MatDemographics) Demographics of woman

Telecom.Work - Patient's work telephone number

Summary	Patient's work telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.Telecom.Work - Mother's work telephone number - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

Telecom.Mobile - Patient's mobile telephone number

Summary	Patient's mobile telephone number
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.Telecom.Mobile - Mother's mobile telephone number - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatDemographics) Demographics of woman

Telecom.Email - Patient's email address

Summary	Patient's email address
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Mat.Telecom.Email - Mother's email address - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - Topic: (MatDemographics) Demographics of woman

Example JSON when WRITING to the Spine

JSON

{
  "resourceType": "Patient",
  "id": "df.gQibYJ1fdEsEkiofF5xtq21LJtFHvyxpRqkbY5yg6BiSoZ3SZl35gf2CD5bXp",
  "meta": {
    "profile": [
      "http://hl7.org.nz/fhir/StructureDefinition/NzPatient"
    ]
  },
  "extension": [
    {
      "url": "http://hl7.org.nz/fhir/maternity/StructureDefinition/maternity-eligibility",
      "valueBoolean": true
    },
    {
      "extension": [
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.clevermed.com/ValueSet/Ethnicity",
                "code": "21"
              }
            ]
          }
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.clevermed.com/ValueSet/Ethnicity",
                "code": "10"
              }
            ]
          }
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.clevermed.com/ValueSet/Ethnicity",
                "code": "42"
              }
            ]
          }
        }
      ],
      "url": "https://clevermed.com/fhir/StructureDefinition/Patient-BNet-Preg-Ethnicities"
    }
  ],
  "identifier": [
    {
      "use": "official",
      "system": "https://standards.digital.health.nz/ns/nhi-id",
      "value": "NationalID123"
    }
  ],
  "name": [
    {
      "use": "official",
      "family": "Britt",
      "given": [
        "Edie",
        "middlename"
      ],
      "prefix": [
        "Ms"
      ],
      "suffix": [
        "M.L.A"
      ]
    },
    {
      "use": "usual",
      "given": [
        "May"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "0123456789",
      "use": "home"
    },
    {
      "system": "phone",
      "value": "0987654321",
      "use": "work"
    },
    {
      "system": "phone",
      "value": "0246813579",
      "use": "mobile"
    },
    {
      "system": "email",
      "value": "work@spineexample.co.uk",
      "use": "work"
    },
    {
      "system": "email",
      "value": "home@spineexample.co.uk",
      "use": "home"
    }
  ],
  "birthDate": "1990-05-19",
  "address": [
    {
      "extension": [
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
          "valueString": "Fairview suburb"
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                "code": "0403"
              }
            ]
          }
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
          "valueString": "Building A"
        }
      ],
      "use": "home",
      "line": [
        "4353",
        "Wisteria Lane",
        "A studio"
      ],
      "city": "Fairview",
      "postalCode": "EH3 9QG",
      "country": "New Zealand"
    }
  ],
  "contact": [
    {
      "relationship": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/ValueSet/patient-contactrelationship",
              "code": "N",
              "display": "Next of Kin"
            }
          ]
        }
      ],
      "name": {
        "use": "usual",
        "family": "Mike",
        "given": [
          "Delfino"
        ]
      },
      "telecom": [
        {
          "system": "phone",
          "value": "01223334444",
          "use": "home"
        },
        {
          "system": "phone",
          "value": "04444333221",
          "use": "work"
        },
        {
          "system": "phone",
          "value": "0133355555",
          "use": "mobile"
        },
        {
          "system": "email",
          "value": "nok_work@spineexample.co.uk",
          "use": "work"
        },
        {
          "system": "email",
          "value": "nok_home@spineexample.co.uk",
          "use": "home"
        }
      ],
      "address": {
        "extension": [
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
            "valueString": "Fairview suburb B"
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                  "code": "0403"
                }
              ]
            }
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
            "valueString": "Building B"
          }
        ],
        "line": [
          "4353",
          "Wisteria Lane"
        ],
        "city": "Fairview",
        "postalCode": "EH3 9QG"
      }
    },
    {
      "relationship": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/ValueSet/patient-contactrelationship",
              "code": "C",
              "display": "Emergency Contact"
            }
          ]
        }
      ],
      "name": {
        "use": "usual",
        "family": "Van de Kamp",
        "given": [
          "Bree"
        ]
      },
      "telecom": [
        {
          "system": "phone",
          "value": "09887776666",
          "use": "home"
        },
        {
          "system": "phone",
          "value": "07889990000",
          "use": "work"
        },
        {
          "system": "phone",
          "value": "0975312468",
          "use": "mobile"
        }
      ],
      "address": {
        "extension": [
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
            "valueString": "Fairview suburb C"
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                  "code": "0403"
                }
              ]
            }
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
            "valueString": "Building C"
          }
        ],
        "line": [
          "4354",
          "Wisteria Lane"
        ],
        "city": "Fairview",
        "postalCode": "EH4 3DR"
      }
    },
    {
      "relationship": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/ValueSet/patient-contactrelationship",
              "code": "C",
              "display": "Emergency Contact"
            }
          ]
        }
      ],
      "name": {
        "use": "usual",
        "family": "Solis",
        "given": [
          "Gabrielle"
        ]
      },
      "telecom": [
        {
          "system": "phone",
          "value": "01335557777",
          "use": "home"
        },
        {
          "system": "phone",
          "value": "07777555331",
          "use": "work"
        },
        {
          "system": "phone",
          "value": "01029384756",
          "use": "mobile"
        }
      ],
      "address": {
        "extension": [
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
            "valueString": "Fairview suburb D"
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                  "code": "0403"
                }
              ]
            }
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
            "valueString": "Building D"
          }
        ],
        "line": [
          "4349",
          "Wisteria Lane"
        ],
        "city": "Fairview",
        "postalCode": "EH1 2NG"
      }
    }
  ],
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/ValueSet/languages",
            "code": "en"
          }
        ]
      }
    }
  ]
}

Example JSON when READING from the Spine

JSON

{
  "resourceType": "Patient",
  "id": "70666E6D5755465747534C486936616E65547A366F477454712D6834425667776C482E6D7646545A54356B754B3563385158794337576541436E6D54752E6D44",
  "meta": {
    "profile": [
      "http://hl7.org.nz/fhir/StructureDefinition/NzPatient"
    ]
  },
  "extension": [
    {
      "url": "http://hl7.org.nz/fhir/maternity/StructureDefinition/maternity-eligibility",
      "valueBoolean": true
    },
    {
      "extension": [
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.clevermed.com/ValueSet/Ethnicity",
                "code": "21"
              }
            ]
          }
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.clevermed.com/ValueSet/Ethnicity",
                "code": "10"
              }
            ]
          }
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.clevermed.com/ValueSet/Ethnicity",
                "code": "42"
              }
            ]
          }
        }
      ],
      "url": "https://clevermed.com/fhir/StructureDefinition/Patient-BNet-Preg-Ethnicities"
    }
  ],
  "identifier": [
    {
      "use": "official",
      "system": "https://standards.digital.health.nz/ns/nhi-id",
      "value": "NationalID123"
    }
  ],
  "name": [
    {
      "use": "official",
      "family": "Perry",
      "given": [
        "Renee",
        "middlename"
      ],
      "prefix": [
        "Ms"
      ],
      "suffix": [
        "PhD"
      ]
    },
    {
      "use": "usual",
      "given": [
        "May"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "0123456789",
      "use": "home"
    },
    {
      "system": "phone",
      "value": "0987654321",
      "use": "work"
    },
    {
      "system": "phone",
      "value": "0246813579",
      "use": "mobile"
    },
    {
      "system": "email",
      "value": "work@spineexample.co.uk",
      "use": "work"
    },
    {
      "system": "email",
      "value": "home@spineexample.co.uk",
      "use": "home"
    }
  ],
  "birthDate": "1990-05-19",
  "address": [
    {
      "extension": [
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
          "valueString": "Fairview suburb"
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                "code": "0403"
              }
            ]
          }
        },
        {
          "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
          "valueString": "Building A"
        }
      ],
      "use": "home",
      "line": [
        "4353",
        "Wisteria Lane",
        "A studio"
      ],
      "city": "Fairview",
      "postalCode": "EH3 9QG",
      "country": "New Zealand"
    }
  ],
  "contact": [
    {
      "relationship": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/ValueSet/patient-contactrelationship",
              "code": "N",
              "display": "Next of Kin"
            }
          ]
        }
      ],
      "name": {
        "use": "usual",
        "family": "Mike",
        "given": [
          "Delfino"
        ]
      },
      "telecom": [
        {
          "system": "phone",
          "value": "01223334444",
          "use": "home"
        },
        {
          "system": "phone",
          "value": "04444333221",
          "use": "work"
        },
        {
          "system": "phone",
          "value": "0133355555",
          "use": "mobile"
        },
        {
          "system": "email",
          "value": "nok_work@spineexample.co.uk",
          "use": "work"
        },
        {
          "system": "email",
          "value": "nok_home@spineexample.co.uk",
          "use": "home"
        }
      ],
      "address": {
        "extension": [
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
            "valueString": "Fairview suburb B"
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                  "code": "0403"
                }
              ]
            }
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
            "valueString": "Building B"
          }
        ],
        "line": [
          "4353",
          "Wisteria Lane"
        ],
        "city": "Fairview",
        "postalCode": "EH3 9QG"
      }
    },
    {
      "relationship": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/ValueSet/patient-contactrelationship",
              "code": "C",
              "display": "Emergency Contact"
            }
          ]
        }
      ],
      "name": {
        "use": "usual",
        "family": "Van de Kamp",
        "given": [
          "Bree"
        ]
      },
      "telecom": [
        {
          "system": "phone",
          "value": "09887776666",
          "use": "home"
        },
        {
          "system": "phone",
          "value": "07889990000",
          "use": "work"
        },
        {
          "system": "phone",
          "value": "0975312468",
          "use": "mobile"
        }
      ],
      "address": {
        "extension": [
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
            "valueString": "Fairview suburb C"
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                  "code": "0403"
                }
              ]
            }
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
            "valueString": "Building C"
          }
        ],
        "line": [
          "4354",
          "Wisteria Lane"
        ],
        "city": "Fairview",
        "postalCode": "EH4 3DR"
      }
    },
    {
      "relationship": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/ValueSet/patient-contactrelationship",
              "code": "C",
              "display": "Emergency Contact"
            }
          ]
        }
      ],
      "name": {
        "use": "usual",
        "family": "Solis",
        "given": [
          "Gabrielle"
        ]
      },
      "telecom": [
        {
          "system": "phone",
          "value": "01335557777",
          "use": "home"
        },
        {
          "system": "phone",
          "value": "07777555331",
          "use": "work"
        },
        {
          "system": "phone",
          "value": "01029384756",
          "use": "mobile"
        }
      ],
      "address": {
        "extension": [
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/suburb",
            "valueString": "Fairview suburb D"
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org.nz/fhir/ValueSet/domicile-code",
                  "code": "0403"
                }
              ]
            }
          },
          {
            "url": "http://hl7.org.nz/fhir/StructureDefinition/building-name",
            "valueString": "Building D"
          }
        ],
        "line": [
          "4349",
          "Wisteria Lane"
        ],
        "city": "Fairview",
        "postalCode": "EH1 2NG"
      }
    }
  ],
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/ValueSet/languages",
            "code": "en"
          }
        ]
      }
    }
  ]
}

CONFIDENTIAL/COMMERCIAL IN CONFIDENCE

Confidentiality/document control

This document contains information that is confidential to System C Healthcare Ltd (System C) and is intended for our customers to use in connection with our products and services. It must not be used for any other purpose nor disclosed to any other party, either whole or in part, without the prior written consent of System C except as follows. A customer may permit those of its employees, advisors and agents having a need to know the contents of this platform to have access to such of the contents as are strictly necessary, but that customer shall ensure that such employees, advisors and agents are bound to it by an obligation, in similar term, to keep it confidential. A customer's acceptance of these obligations shall be indicated by that customer's use of any of the information contained in this document.

System C acknowledges that a customer may be bound by the Freedom of Information Act 2000 (FOIA). In such cases, System C considers that the contents of this document are confidential and exempt from disclosure pursuant to section 41 of the FOIA. A customer should consult System C before making any disclosure of information relating to System C under the FOIA. System C's business information, methodologies, solutions, as well as reference to System C clients and their projects, are always considered by System C to be exempt from disclosure by virtue of section 41 and 43 of the FOIA, whether indicated or not. 

Product Information: any descriptions of future functionality reflect current product direction, are for informational purposes only, and do not constitute a commitment to provide specific functionality. Timing and availability remain at System C’s discretion and are subject to change and applicable regulatory approvals.

Warning: Paper or PDF copies of this document are not version controlled and will automatically be considered obsolete and superseded at the time of printing or conversion.

Confidentiality/document control statement version number 2.0, QMSUID-0059