FamilyMemberHistory-BNet-Preg-MaternalFamilyHistory

FHIR Resource information

FHIR Resource	🌍FamilyMemberHistory-BNet-Preg-MaternalFamilyHistory. Based on 🌍 FamilyMemberHistory
Description	Maternal family history
Release status	IN TEST
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 - Fixed code for the status of the resource

Summary	Fixed code for the status of the resource
Mandatory	Yes
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	None
Fixed value	Fixed code value of 'partial' should be used.

* Patient - Reference to the mother/pregnant person

Summary	Reference to the mother/pregnant person
Mandatory	Yes
Value type	🌍Reference(Patient)
Write allowed	Yes
Data Dictionary item	None

* relationship - Fixed code for the relationship between father and mother

Summary	Fixed code for the relationship between father and mother
Mandatory	Yes
Expected type	🌍codeableConcept
Write allowed	Yes
Data Dictionary item	None
Fixed value	Fixed code value: 'FAMMEMB', CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-RoleCode'', Display: 'family member'

condition.code - Maternal family history condition

Summary	Maternal family history condition
Mandatory	No
Expected type	🌍codeableConcept
Write allowed	Yes
Data Dictionary item	None
Value set used	🌍ValueSet-BNet-Preg-MaternalFamilyHistory

condition.code.text - Maternal family history condition - other

Summary	Maternal family history condition - other
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	MatFamHistory - Maternal family history - DataSet: (NZHISOMAT4) New Zealand HISO Maternity data set (Phase 4) - Topic: (MatBooking) Details at pregnancy booking - Topic: (FamilyHealth) Family health

* extension.episodeOfCare - The episode(s) of care that establishes the context for this resource. In this case, it is a reference to the 'pregnancy' episode of care. The extension URL is: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare

Summary	The episode(s) of care that establishes the context for this resource. In this case, it is a reference to the 'pregnancy' episode of care. The extension URL is: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Mandatory	Yes
Value type	🌍Reference(EpisodeOfCare)
Write allowed	Yes
Data Dictionary item	None

Example JSON when WRITING to the Spine

JSON

{
  "resourceType": "FamilyMemberHistory",
  "status": "partial",
  "patient": {
    "reference": "Patient/pfnmWUFWGSLHi6aneTz6oGtTq-h4BVgwlH.mvFTZT5kuK5c8QXyC7WeACnmTu.mD",
    "type": "Patient"
  },
  "relationship": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "code": "FAMMEMB",
        "display": "Family member"
      }
    ]
  },
  "condition": [
    {
      "code": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "160469004",
            "display": "Family history: Allergy"
          }
        ]
      }
    }
  ]
}

Example JSON when READING from the Spine

JSON

{
  "resourceType": "FamilyMemberHistory",
  "id": "4F62736572766174696F6E2D424E65742D4368696C642D436F6E67656E6974616C4D616C666F726D6174696F6E73",
  "meta": {
    "profile": [
      "https://fhir.clevermed.com/StructureDefinition/FamilyMemberHistory-BNet-Preg-MaternalFamilyHistory"
    ]
  },
  "status": "partial",
  "patient": {
    "reference": "Patient/pfnmWUFWGSLHi6aneTz6oGtTq-h4BVgwlH.mvFTZT5kuK5c8QXyC7WeACnmTu.mD",
    "type": "Patient"
  },
  "relationship": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "code": "FAMMEMB",
        "display": "Family member"
      }
    ]
  },
  "condition": [
    {
      "code": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "160469004",
            "display": "Family history: Allergy"
          }
        ]
      }
    }
  ]
}

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