Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is the API documentation  for the OpenMRS FHIR Module ,FamilyHistory Resource. 

...

Code Block
titleFHIR FamilyHistory Resource
{
  "resourceType": "FamilyHistory",
  "id": "dda12af7-1691-11df-97a5-7038c432aabf",
  "patient": {
    "reference": "Patient/example",
    "display": "Peter Patient"
  },
  "relation": [
    {
      "relationship": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/familial-relationship",
            "code": "father"
          }
        ]
      },
      "condition": [
        {
          "type": {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "315619001",
                "display": "Myocardial Infarction"
              }
            ],
            "text": "Heart Attack"
          },
          "onsetAge": {
            "value": 74,
            "units": "a",
            "system": "http://unitsofmeasure.org"
          },
          "note": "Was fishing at the time. At least he went doing someting he loved."
        }
      ]
    }
  ]
}

Available RESTful web services for the FamilyHistory Resource supported by the API

urldescription
/ws/fhir/FamilyHistory/{patientId}
Above request will fetch the FamilyHistory for the given unique uuid. Here id represents, the logical resource id(uuid) associated with the resource.
/ws/fhir/FamilyHistory?_id={patientId}
Above request will fetch all the FamilyHistory using the given uuid value. This will give a List of FamilyHistory as the response.Here _id parameter represents, the logical resource id(uuid) associated with the resource.
/ws/fhir/FamilyHistory?subject={patientId}
Above request will fetch all the FamilyHistory related to the given patient id. This will give a List of FamilyHistory as the response. Here subject parameter represents, the uuid of the patient whose history is about.