CarePlan-BNet-Preg-PlannedPlaceOfBirth

FHIR Resource information

FHIR Resource	🌍CarePlan-BNet-Preg-PlannedPlaceOfBirth. Based on 🌍 CarePlan
Description	Planned Place of Birth
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

category - Fixed code for planned place of Birth.

Summary	Fixed code for planned place of Birth.
Description	Fixed single SNOMED code that identifies this CAREPLAN resource as being for the update of Planned Place Of Birth.
Mandatory	No
Expected type	🌍codeableConcept
Write allowed	Yes
Data Dictionary item	None
Fixed value	Fixed code value: '310585007', CodeSystem: 'snomed'', Display: 'Planned place of birth'

* created - Date and time for when this information is to be recorded in the patient notes.

Summary	Date and time for when this information is to be recorded in the patient notes.
Description	Clients can send multiple separate instances of this resource with a different created datetime stamp in each. This models to the concept of keeping a time-based record of when the intended place of birth is changed.
Mandatory	Yes
Expected type	🌍dateTime
Write allowed	Yes
Data Dictionary item	None

* activity.detail.code - Place or facility where the woman plans to give birth

Summary	Place or facility where the woman plans to give birth
Mandatory	Yes
Expected type	🌍codeableConcept
Write allowed	Yes
Data Dictionary item	PlannedPOB_Type - Planned place of birth type - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatBooking) Details at pregnancy booking
Value set used	🌍ValueSet-BNet-Preg-PlannedPlaceOfBirth

activity.detail.code.text - A free text string for when 'other' is used in 'activity.detail.code'

Summary	A free text string for when 'other' is used in 'activity.detail.code'
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	PlannedPOB_TypeOther - Planned place of birth type - 'other' - detail - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatBooking) Details at pregnancy booking

activity.detail.performer - National ID for care location.

Summary	National ID for care location.
Description	NHS Organisation code or NZ National organisation code provided as an organisation identifier. Where the "Facility Type" element is defined as a primary birthing facility, a seconday birthing facility or a tertiary birthing facility, the client must provide the organisation reference as an identifier. Otherwise, it is non-mandatory. The reference is provided with the reference.identifier element. For this element, the clients operating in New Zealand will send the NZ HPI Facility ID as defined by https://standards.digital.health.nz/ns/hpi-facility-id.
Mandatory	No
Value type	🌍Reference(Organization)
Write allowed	Yes
Data Dictionary item	PlannedPOB_facility - Planned place of birth - facility - DataSet: (NZHISOMAT1) New Zealand HISO Maternity data set (Phase 1) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (MatBooking) Details at pregnancy booking

* activity.detail.status - Fixed code to set this care plan to 'scheduled'

Summary	Fixed code to set this care plan to 'scheduled'
Mandatory	Yes
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	None
Fixed value	Fixed code value of 'scheduled' should be used.

* status - Indicates that the plan is in force and ready to be acted upon

Summary	Indicates that the plan is in force and ready to be acted upon
Mandatory	Yes
Expected type	🌍code
Write allowed	No
Data Dictionary item	None
Fixed value	Fixed code value of 'active' should be used.

* intent - Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

Summary	Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
Description	The fixed value here represents an intention which ensures that the careplan can occur without further authorisation for others to act.
Mandatory	Yes
Expected type	🌍code
Write allowed	No
Data Dictionary item	None
Fixed value	Fixed code value of 'plan' should be used.

* subject - A reference to the patient that this care plan is for

Summary	A reference to the patient that this care plan is for
Mandatory	Yes
Value type	🌍Reference(Patient)
Write allowed	Yes
Data Dictionary item	None

Example JSON when WRITING to the Spine

JSON

{
  "resourceType": "CarePlan",
  "meta": {
    "profile": [
      "https://fhir.clevermed.com/StructureDefinition/CarePlan-BNet-Preg-PlannedPlaceOfBirth"
    ]
  },
  "status": "active",
  "intent": "plan",
  "category": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "310585007",
          "display": "Planned place of birth"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/pfnmwufwgslhi6anetz6ogttq-h4bvgwlh.mvftzt5kuk5c8qxyc7weacnmtu.md"
  },
  "created": "2025-03-25T15:48:12.9566795+00:00",
  "activity": [
    {
      "detail": {
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "91731000210104",
              "display": "Primary birthing facility"
            }
          ]
        },
        "status": "scheduled",
        "performer": [
          {
            "identifier": {
              "system": "https://standards.digital.health.nz/ns/hpi-facility-id",
              "value": "F2S027-E"
            }
          }
        ]
      }
    }
  ]
}

Example JSON when READING from the Spine

JSON

{
  "resourceType": "Bundle",
  "id": "5bedc78f-1c31-473a-a0a2-efa505bdd46a",
  "entry": [
    {
      "resource": {
        "resourceType": "CarePlan",
        "id": "3436393734323535396534303466663539326133336138353938393436326162",
        "meta": {
          "profile": [
            "https://fhir.clevermed.com/StructureDefinition/CarePlan-BNet-Preg-PlannedPlaceOfBirth"
          ]
        },
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare",
            "valueReference": {
              "reference": "EpisodeOfCare/pfnmWUFWGSLHi6aneTz6oGtTq-h4BVgwlH.mvFTZT5kuK5c8QXyC7WeACnmTu.mD"
            }
          }
        ],
        "status": "active",
        "intent": "plan",
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "310585007",
                "display": "Planned place of birth"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/pfnmwufwgslhi6anetz6ogttq-h4bvgwlh.mvftzt5kuk5c8qxyc7weacnmtu.md"
        },
        "created": "2025-03-25T15:48:12.9566795+00:00",
        "activity": [
          {
            "detail": {
              "code": {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "91731000210104",
                    "display": "Primary birthing facility"
                  }
                ]
              },
              "status": "scheduled",
              "performer": [
                {
                  "identifier": {
                    "system": "https://standards.digital.health.nz/ns/hpi-facility-id",
                    "value": "F2S027-E"
                  }
                }
              ]
            }
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Organization",
        "id": "3732396664646639356262633463633738346364656335336666383239636137",
        "meta": {
          "profile": [
            "https://clevermed.com/fhir/StructureDefinition/Organization-BNet-CareLocation"
          ]
        },
        "identifier": [
          {
            "use": "official",
            "system": "BadgerNetCareLocation",
            "value": "a15405d7-5e8d-4533-bd48-952135a77f43"
          }
        ],
        "type": [
          {
            "coding": [
              {
                "system": "BadgerNetCustom",
                "code": "mat"
              }
            ],
            "text": "Maternity Care Location"
          }
        ],
        "name": "The Prince Harry Happy Hospital",
        "address": [
          {
            "use": "work",
            "line": [
              "123 Hospital Street"
            ],
            "city": "Harrysville",
            "postalCode": "1234"
          }
        ]
      }
    }
  ]
}

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