Skip to main content
Skip table of contents

CareTeam-BNet-Preg

FHIR Resource information

FHIR Resource

🌍CareTeam-BNet-Preg. Based on 🌍 CareTeam

Description

Care team update resource for pregnancy record.

Release status

LIVE

Cardinality

Single instance

Writing to Spine permitted

YES - for Spine Client Type (MAT)

Spine filters

NZMAT-HISO, PREGSUM

Key FHIR Resource elements used

* period.start - Care team start period

Summary

Care team start period

Mandatory

Yes

Expected type

🌍dateTime

Write allowed

Yes

Data Dictionary item

CareTeam_StartPeriod - Date and and time at which the care team commenced care
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

participant[x].role.coding[0] - Team Participant Type

Summary

Team Participant Type

Description

This data item is now a legacy option. Thus, for a short period, clients are able to send both this option and the newer role code option below.

NZ clients are must send "LeadMidwife". UK clients must send 'leadprofessional'.

Mandatory

No

Expected type

🌍codeableConcept

Write allowed

Yes

Data Dictionary items

CareTeam_NZParticipantType - New Zealand care team participant type
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person
CareTeam_UKParticipantType - UK care team participant type
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
   - Topic: (ProviderPerson) Provider person
CareTeam_UKGP - Registered GP
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
   - Topic: (ProviderPerson) Provider person

Value set used

🌍ValueSet-BNet-Preg-ParticipantType

participant[x].role.coding[1] - Team Participant Type

Summary

Team Participant Type

Description

This is the new valueset, which will supersede the valueset ValueSet-BNet-Preg-ParticipantType.

Mandatory

No

Expected type

🌍codeableConcept

Write allowed

Yes

Data Dictionary item

CareTeam_NZParticipantType - New Zealand care team participant type
   - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1)
   - Topic: (ProviderPerson) Provider person

Value set used

🌍ValueSet-BNet-Preg-LMCType

* participant[x].member.reference - Reference for the professional or organisation

Summary

Reference for the professional or organisation

Description

This reference's logical ID must match the "ID" element from a practitioner resource (https://docs.badger.link/cdl/practitioner-bnet-preg) in the same bundle. Where the participant type is a GP, this should use reference(organisation)

Mandatory

Yes

Value type

🌍Reference(Practitioner) or Reference(Organisation)

Write allowed

Yes

Data Dictionary item

None

Example JSON when WRITING to the Spine

JSON
{
  "resourceType": "CareTeam",
  "id": "4af78e058d8802092a4c0e05a3142f75db1af116732443eb45589a8d6e5d39cc",
  "period": {
    "start": "2025-05-09T16:18:27.7053265+01:00"
  },
  "participant": [
    {
      "role": [
        {
          "coding": [
            {
              "code": "leadmidwife"
            }
          ]
        },
        {
          "coding": [
            {
              "system": "https://fhir.clevermed.com/ValueSet/LMCType",
              "code": "2"
            }
          ]
        }
      ],
      "member": {
        "reference": "Practitioner/ee1a30bafb39f68aa986576fac83d1b18c05e066e9af8359da82c92c1527995c",
        "type": "Practitioner"
      }
    },
    {
      "role": [
        {
          "coding": [
            {
              "code": "gp"
            }
          ]
        }
      ]
    }
  ]
}

Example JSON when READING from the Spine

JSON
{
  "resourceType": "CareTeam",
  "id": "4F62736572766174696F6E2D424E65742D4368696C642D436F6E67656E6974616C4D616C666F726D6174696F6E73",
  "meta": {
    "profile": [
      "https://fhir.clevermed.com/StructureDefinition/CareTeam-BNet-Preg"
    ]
  },
  "period": {
    "start": "2025-05-09T16:18:27.7754823+01:00"
  },
  "participant": [
    {
      "role": [
        {
          "coding": [
            {
              "code": "leadmidwife"
            }
          ]
        },
        {
          "coding": [
            {
              "system": "https://fhir.clevermed.com/ValueSet/LMCType",
              "code": "2"
            }
          ]
        }
      ],
      "member": {
        "reference": "Practitioner/6ccbdd78ea47366cff7112a37c75d072bd9322255c6f9ce2cec98ae3c7b9cfbe",
        "type": "Practitioner"
      }
    },
    {
      "role": [
        {
          "coding": [
            {
              "code": "gp"
            }
          ]
        }
      ]
    }
  ]
}


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.