Skip to main content
Skip table of contents

Encounter-BNet-Preg-KeyEvents

FHIR Resource information

FHIR Resource

🌍Encounter-BNet-Preg-KeyEvents. Based on 🌍 Encounter

Description

Dates and time stamps for admissions

Release status

LIVE

Cardinality

TBD

Writing to Spine permitted

YES - for Spine Client Type ()

Spine filters

PREGSUM

Key FHIR Resource elements used

* class - Fixed code for the class of the encounter

Summary

Fixed code for the class of the encounter

Mandatory

Yes

Expected type

🌍code

Write allowed

Yes

Data Dictionary item

None

Fixed value

Fixed code value of 'IMP' should be used.

* status - Fixed code for the status of the encounter

Summary

Fixed code for the status of the encounter

Mandatory

Yes

Expected type

🌍code

Write allowed

Yes

Data Dictionary item

None

Fixed value

Fixed code value of 'in-progress' should be used.

subject - Reference back to root mother/pregnant person resource. The root patient resource should have an ID of $“Patient/{LogicalID}”

Summary

Reference back to root mother/pregnant person resource. The root patient resource should have an ID of $“Patient/{LogicalID}”

Mandatory

No

Value type

🌍Reference(Patient)

Write allowed

Yes

Data Dictionary item

None

serviceType - Broad categorization of the service that is to be provided

Summary

Broad categorization of the service that is to be provided

Mandatory

No

Expected type

🌍codeableConcept

Write allowed

Yes

Data Dictionary item

AN_Any - Any antenatal admissions
   - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4)
   - Topic: (WomanAdmissions) Any admissions of woman

Value set used

🌍ValueSet-BNet-Preg-KeyEventAdmittedType

period.start - Refers to the time during which the patient was admitted

Summary

Refers to the time during which the patient was admitted

Mandatory

No

Expected type

🌍dateTime

Write allowed

Yes

Data Dictionary items

AdmissionStartDateTime - Admission start date time
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
   - Topic: (WomanAdmissions) Any admissions of woman
AN_DateTime - Antenatal admission - date and time
   - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4)
   - Topic: (WomanAdmissions) Any admissions of woman
PostnAdmission_DateTime - Mother Postnatal admission - date and time
   - Topic: (WomanAdmissions) Any admissions of woman
   - Topic: (WomanPostnatal) Woman details during postnatal period
Postn_MotherAdmission - Any Mother Postnatal admissions
   - DataSet: (NZHISOMAT3) New Zealand HISO Maternity data set (Phase 3)
   - Topic: (WomanAdmissions) Any admissions of woman
   - Topic: (WomanPostnatal) Woman details during postnatal period
MatFac_datetime - Maternity facility admission - date and time
   - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2)
   - Topic: (LabourBirth) Labour and birth

period.end - Refers to the time during which the patient was discharged

Summary

Refers to the time during which the patient was discharged

Mandatory

No

Expected type

🌍dateTime

Write allowed

Yes

Data Dictionary items

AdmissionEndDateTime - Admission end date time
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
   - Topic: (WomanAdmissions) Any admissions of woman
MatDischarge_DateTime - Maternity facility discharge - date and time
   - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4)
   - Topic: (WomanAdmissions) Any admissions of woman
PostN_DischargeDateTime - Postnatal discharge - date and time
   - DataSet: (NZHISOMAT3) New Zealand HISO Maternity data set (Phase 3)
   - Topic: (WomanAdmissions) Any admissions of woman
   - Topic: (WomanPostnatal) Woman details during postnatal period
AN_DischargeDateTime - Antenatal discharge - date and time
   - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4)
   - Topic: (WomanAdmissions) Any admissions of woman

reason.coding - Reason for this admission encounter

Summary

Reason for this admission encounter

Mandatory

No

Expected type

🌍codeableConcept

Write allowed

Yes

Data Dictionary item

AdmissionMainReason - Admission main reason
   - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set
   - Topic: (WomanAdmissions) Any admissions of woman

Value set used

🌍ValueSet-BNet-Preg-KeyEventMainReason

reason.coding.text - String for 'other' value

Summary

String for 'other' value

Mandatory

No

Expected type

🌍string

Write allowed

Yes

Data Dictionary item

None

serviceProvider - The organization (facility) responsible for this admission

Summary

The organization (facility) responsible for this admission

Description

When sent, the active care location for the pregnancy record will automatically switch to the provided care location in this element, and an admission date time is sent.
When a discharge date time is sent, the care location will be automatically changed back to the preceding active care location.

Mandatory

No

Expected type

🌍reference(organinsation)

Write allowed

Yes

Data Dictionary item

None

Example JSON when WRITING to the Spine

JSON
{
  "resourceType": "Encounter",
  "status": "in-progress",
  "class": {
    "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode",
    "code": "IMP"
  },
  "serviceType": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "394575008",
        "display": "Postnatal clinic"
      }
    ]
  },
  "subject": {
    "reference": "Patient/pfnmWUFWGSLHi6aneTz6oGtTq-h4BVgwlH.mvFTZT5kuK5c8QXyC7WeACnmTu.mD",
    "type": "Patient"
  },
  "period": {
    "start": "2022-05-01T22:01:00+01:00",
    "end": "2022-05-02T00:00:00+01:00"
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "https://fhir.clevermed.com/codesystem",
          "code": "APH",
          "display": "APH"
        }
      ]
    }
  ]
}

Example JSON when READING from the Spine

JSON
{
  "resourceType": "Encounter",
  "id": "4F62736572766174696F6E2D424E65742D4368696C642D436F6E67656E6974616C4D616C666F726D6174696F6E73",
  "meta": {
    "profile": [
      "https://fhir.clevermed.com/StructureDefinition/Encounter-BNet-Preg-KeyEvents"
    ]
  },
  "status": "in-progress",
  "class": {
    "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode",
    "code": "IMP"
  },
  "serviceType": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "394575008",
        "display": "Postnatal clinic"
      }
    ]
  },
  "subject": {
    "reference": "Patient/pfnmWUFWGSLHi6aneTz6oGtTq-h4BVgwlH.mvFTZT5kuK5c8QXyC7WeACnmTu.mD",
    "type": "Patient"
  },
  "period": {
    "start": "2022-05-01T22:01:00+01:00",
    "end": "2022-05-02T00:00:00+01:00"
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "https://fhir.clevermed.com/codesystem",
          "code": "APH",
          "display": "APH"
        }
      ]
    }
  ]
}


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.