Skip to main content
Skip table of contents

ServiceRequest-BNet-Referral

FHIR Resource information

FHIR Resource

🌍ServiceRequest-BNet-Referral. Based on 🌍 ServiceRequest

Description

Referral code and date time.

Release status

LIVE

Cardinality

Single Instance

Writing to Spine permitted

YES - for Spine Client Type (MAT)

Spine filters

None

Key FHIR Resource elements used

* id - Unique resource identifier

Summary

Unique resource identifier

Mandatory

Yes

Expected type

🌍string

Write allowed

No

Data Dictionary item

None

* status - Status of the referral

Summary

Status of the referral

Mandatory

Yes

Expected type

🌍code

Write allowed

Yes

Data Dictionary item

None

Fixed value

Fixed code value of 'active' should be used.

* category - Category to define service request as a referral

Summary

Category to define service request as a referral

Mandatory

Yes

Expected type

🌍codeableConcept

Write allowed

Yes

Data Dictionary item

None

Fixed value

Fixed code value: '3457005', CodeSystem: 'SNOMED'', Display: 'Patient referral'

* intent - Intent of the referral

Summary

Intent of the referral

Mandatory

Yes

Expected type

🌍code

Write allowed

Yes

Data Dictionary item

None

Fixed value

Fixed code value of 'order' should be used.

* subject - Reference to the intended patient. This can either be the child or pregnant person

Summary

Reference to the intended patient. This can either be the child or pregnant person

Mandatory

Yes

Value type

🌍Reference(Patient)

Write allowed

Yes

Data Dictionary item

None

* occurrenceDateTime - Date and time for when the referal was made

Summary

Date and time for when the referal was made

Mandatory

Yes

Expected type

🌍dateTime

Write allowed

Yes

Data Dictionary items

LabBirth_ReferralDateTime - Labour and birth referral - date and time
   - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2)
   - Topic: (LabourBirth) Labour and birth
NewBorn_ReferralDate - Newborn referral - date
   - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2)
   - Topic: (NewbornBaby) Details of baby at time of birth
PostN_ReferralDate - Postnatal referral of woman - date
   - DataSet: (NZHISOMAT3) New Zealand HISO Maternity data set (Phase 3)
   - Topic: (WomanPostnatal) Woman details during postnatal period
AN_RefDate - Antenatal referral - date
   - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4)
   - Topic: (Referrals) Any referrals
NNReferral_DateTime - Paediatric referral - date
   - DataSet: (NZHISOMAT3) New Zealand HISO Maternity data set (Phase 3)
   - Topic: (ChildPostnatal) Child details during postnatal period

* code.coding.code - Code which defines what type of referal was made.

Summary

Code which defines what type of referal was made.

Description

Referral codes in NZ are defined in: https://www.health.govt.nz/system/files/documents/publications/referral-glines-jan12.pdf

Mandatory

Yes

Expected type

🌍codeableConcept

Write allowed

Yes

Data Dictionary items

LabBirth_ReferralCode - Labour and birth referral code
   - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2)
   - Topic: (LabourBirth) Labour and birth
NewBorn_ReferralCode - Newborn referral - date
   - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2)
   - Topic: (NewbornBaby) Details of baby at time of birth
PostN_Referral - Postnatal referral of woman
   - DataSet: (NZHISOMAT3) New Zealand HISO Maternity data set (Phase 3)
   - Topic: (WomanPostnatal) Woman details during postnatal period
AN_RefCode - Antenatal referral code
   - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4)
   - Topic: (Referrals) Any referrals
AN_Ref - Antenatal referrals
   - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4)
   - Topic: (Referrals) Any referrals
NNReferral - Paediatric referral
   - DataSet: (NZHISOMAT3) New Zealand HISO Maternity data set (Phase 3)
   - Topic: (ChildPostnatal) Child details during postnatal period

Value set used

🌍ValueSet-BNet-Preg-ReferralReason

Example JSON when WRITING to the Spine

JSON
{
  "resourceType": "ServiceRequest",
  "meta": {
    "profile": [
      "https://fhir.clevermed.com/StructureDefinition/ServiceRequest-BNet-Referral"
    ]
  },
  "status": "active",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "3457005",
          "display": "Patient Referral"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.clevermed.com/valueset/ReferralReason",
        "code": "1034",
        "display": "Anaemia | Hb less than 90 g/L, not responding to treatment | Consultation"
      }
    ]
  },
  "subject": {
    "reference": "Patient/pfnmWUFWGSLHi6aneTz6oGtTq-h4BVgwlH.mvFTZT5kuK5c8QXyC7WeACnmTu.mD",
    "type": "Patient"
  },
  "occurrenceDateTime": "2025-07-31T16:04:02.0808333+00:00"
}

Example JSON when READING from the Spine

JSON
{
  "resourceType": "ServiceRequest",
  "id": "4F62736572766174696F6E2D424E65742D4368696C642D436F6E67656E6974616C4D616C666F726D6174696F6E73",
  "meta": {
    "profile": [
      "https://fhir.clevermed.com/StructureDefinition/ServiceRequest-BNet-Referral"
    ]
  },
  "status": "active",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "3457005",
          "display": "Patient Referral"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.clevermed.com/valueset/ReferralReason",
        "code": "1061",
        "display": "Glomerulonephritis | Transfer"
      }
    ]
  },
  "subject": {
    "reference": "Patient/pfnmWUFWGSLHi6aneTz6oGtTq-h4BVgwlH.mvFTZT5kuK5c8QXyC7WeACnmTu.mD",
    "type": "Patient"
  },
  "occurrenceDateTime": "2025-07-31T16:04:02.0901572+00:00"
}


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.