Skip to main content
Skip table of contents

Practitioner-BNet-Preg

FHIR Resource information

FHIR Resource

🌍Practitioner-BNet-Preg. Based on 🌍 Practitioner

Description

Practitioner details.

Release status

LIVE

Cardinality

N/A

Writing to Spine permitted

YES - for Spine Client Type (MAT)

Spine filters

NZMAT-HISO

Key FHIR Resource elements used

* id - Logical ID for practitioner which should be used in conjunction with other resources in a bundle for referencing purposes.

Summary

Logical ID for practitioner which should be used in conjunction with other resources in a bundle for referencing purposes.

Mandatory

Yes

Expected type

🌍id

Write allowed

Yes

Data Dictionary item

None

* identifier.value - Practitioner CPN

Summary

Practitioner CPN

Mandatory

Yes

Expected type

🌍String

Write allowed

Yes

Data Dictionary item

CareTeam_CPN - Care team member's common person number
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

* identifier.system - Fixed system of 'cpn'

Summary

Fixed system of 'cpn'

Mandatory

Yes

Expected type

🌍uri

Write allowed

Yes

Data Dictionary item

None

name.prefix - Practitioner Title

Summary

Practitioner Title

Mandatory

No

Expected type

🌍String

Write allowed

Yes

Data Dictionary item

CareTeam_Title - Care team member's title
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

* name.family - Practitioner Surname

Summary

Practitioner Surname

Mandatory

Yes

Expected type

🌍String

Write allowed

Yes

Data Dictionary item

CareTeam_Surename - Care team member's surename
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

* name.given - Practitioner First Name

Summary

Practitioner First Name

Mandatory

Yes

Expected type

🌍String

Write allowed

Yes

Data Dictionary item

CareTeam_Firstname - Care team member's first name
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

telecom.value - Practitioner Work Telephone or email address

Summary

Practitioner Work Telephone or email address

Mandatory

No

Expected type

🌍String

Write allowed

Yes

Data Dictionary items

CareTeam_Telephone - Care team telephone number
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
   - Topic: (ProviderPerson) Provider person
CareTeam_Email - Care team email address
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
CareTeam_Mobile - Care team telephone number
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
   - Topic: (ProviderPerson) Provider person

telecom.system -

Summary

Mandatory

No

Expected type

🌍code

Write allowed

Yes

Data Dictionary item

None

Value set used

🌍ValueSet-BNet-Preg-TelecomSystem

telecom.use - Where the system is 'email', use should be 'work'

Summary

Where the system is 'email', use should be 'work'

Mandatory

No

Expected type

🌍code

Write allowed

Yes

Data Dictionary item

None

Value set used

🌍ValueSet-BNet-Preg-TelecomUse

address.line[x] - Practitioner Work Address

Summary

Practitioner Work Address

Mandatory

No

Expected type

🌍String

Write allowed

Yes

Data Dictionary item

CareTeam_Address - Care team member's address
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

address.postalCode - Practitioner Work Postcode

Summary

Practitioner Work Postcode

Mandatory

No

Expected type

🌍String

Write allowed

Yes

Data Dictionary item

CareTeam_Postcode - Care team member's postcode
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

qualification.code - Code to define the lead maternity carer type

Summary

Code to define the lead maternity carer type

Mandatory

No

Expected type

🌍codeableConcept

Write allowed

Yes

Data Dictionary item

- (DATA ITEM NOT IN INDEX)

Value set used

🌍ValueSet-BNet-Preg-NZLMCTypes

Example JSON when WRITING to the Spine

JSON
{
  "resourceType": "Practitioner",
  "id": "3830653663303134353636653436383461303834323438653663356635633035",
  "identifier": [
    {
      "system": "cpn",
      "value": "CPN12345"
    }
  ],
  "name": [
    {
      "family": "Grey",
      "given": [
        "Meredith"
      ],
      "prefix": [
        "Dr"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "9-3612",
      "use": "work"
    },
    {
      "system": "phone",
      "value": "0123456789",
      "use": "mobile"
    },
    {
      "system": "email",
      "value": "m.gray@gsmh.hospital",
      "use": "work"
    }
  ],
  "address": [
    {
      "line": [
        "Grey Sloan Memorial Hospital",
        "15000",
        "Centennial Drive"
      ],
      "city": "Seattle",
      "postalCode": "98109"
    }
  ],
  "qualification": [
    {
      "code": {
        "coding": [
          {
            "system": "https://fhir.clevermed.com/ValueSet/Lead-Maternity-Carer-Type",
            "code": "2",
            "display": "Registrant with the Midwifery Council of New Zealand"
          }
        ]
      }
    }
  ]
}

Example JSON when READING from the Spine

JSON
{
  "resourceType": "Practitioner",
  "id": "3830653663303134353636653436383461303834323438653663356635633035",
  "identifier": [
    {
      "system": "cpn",
      "value": "CPN12345"
    }
  ],
  "name": [
    {
      "family": "Grey",
      "given": [
        "Meredith"
      ],
      "prefix": [
        "Dr"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "9-3612",
      "use": "work"
    },
    {
      "system": "phone",
      "value": "0123456789",
      "use": "mobile"
    },
    {
      "system": "email",
      "value": "m.gray@gsmh.hospital",
      "use": "work"
    }
  ],
  "address": [
    {
      "line": [
        "Grey Sloan Memorial Hospital",
        "15000",
        "Centennial Drive"
      ],
      "city": "Seattle",
      "postalCode": "98109"
    }
  ],
  "qualification": [
    {
      "code": {
        "coding": [
          {
            "system": "https://fhir.clevermed.com/ValueSet/Lead-Maternity-Carer-Type",
            "code": "2",
            "display": "Registrant with the Midwifery Council of New Zealand"
          }
        ]
      }
    }
  ]
}


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
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.