DHIS2 Example FHIR Implementation Guide
1.0.0 - ci-build International flag

DHIS2 Example FHIR Implementation Guide, published by DHIS2. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/JohanGHole/alldevs-demo-ig and changes regularly. See the Directory of published versions

Logical Model: PatientInfo - JSON Profile

Draft as of 2023-09-28

JSON representation of the PatientInfo logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "PatientInfo",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Placeholder</div>"
  },
  "url" : "https://dhis2.org/StructureDefinition/PatientInfo",
  "version" : "1.0.0",
  "name" : "PatientInfo",
  "title" : "Base Patient Data Model",
  "status" : "draft",
  "date" : "2023-09-28T13:33:49+00:00",
  "publisher" : "DHIS2",
  "contact" : [
    {
      "name" : "DHIS2",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://dhis2.org"
        },
        {
          "system" : "email",
          "value" : "integration@dhis2.org"
        }
      ]
    },
    {
      "name" : "Johan Hole",
      "telecom" : [
        {
          "system" : "email",
          "value" : "Johan@Devotta.no",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "Representation of common DHIS2 tracked entity properties.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "https://dhis2.org/StructureDefinition/PatientInfo",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "PatientInfo",
        "path" : "PatientInfo",
        "short" : "Base Patient Data Model",
        "definition" : "Representation of common DHIS2 tracked entity properties.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false
      },
      {
        "id" : "PatientInfo.registrationDateTime",
        "path" : "PatientInfo.registrationDateTime",
        "short" : "Date-Time information was entered",
        "definition" : "Date and Time when the patient information was entered into DHIS2",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.registrationDateTime",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "dateTime"
          }
        ]
      },
      {
        "id" : "PatientInfo.firstregisteredAt",
        "path" : "PatientInfo.firstregisteredAt",
        "short" : "The Org unit where the patient was first registered",
        "definition" : "The Org unit where the patient was first registered",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.firstregisteredAt",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id" : "PatientInfo.firstName",
        "path" : "PatientInfo.firstName",
        "short" : "Given name of the patient",
        "definition" : "Given name of the patient",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.firstName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.lastName",
        "path" : "PatientInfo.lastName",
        "short" : "Family name",
        "definition" : "Family name",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.lastName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.dateOfBirth",
        "path" : "PatientInfo.dateOfBirth",
        "short" : "...",
        "definition" : "...",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.dateOfBirth",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.dateOfBirthIsEstimated",
        "path" : "PatientInfo.dateOfBirthIsEstimated",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.dateOfBirthIsEstimated",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean"
          }
        ]
      },
      {
        "id" : "PatientInfo.sexAtBirth",
        "path" : "PatientInfo.sexAtBirth",
        "short" : "...",
        "definition" : "...",
        "comment" : "(valueset depends on the program)",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.sexAtBirth",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "https://dhis2.org/ValueSet/patient-sex-at-birth-vs"
        }
      },
      {
        "id" : "PatientInfo.currentHomeAddress",
        "path" : "PatientInfo.currentHomeAddress",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.currentHomeAddress",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.contactPhoneNumber",
        "path" : "PatientInfo.contactPhoneNumber",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.contactPhoneNumber",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.countryOfBirth",
        "path" : "PatientInfo.countryOfBirth",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.countryOfBirth",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "urn:iso:std:iso:3166"
        }
      },
      {
        "id" : "PatientInfo.nationaId",
        "path" : "PatientInfo.nationaId",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.nationaId",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.consent",
        "path" : "PatientInfo.consent",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PatientInfo.consent",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "PatientInfo",
        "path" : "PatientInfo",
        "short" : "Base Patient Data Model",
        "definition" : "Representation of common DHIS2 tracked entity properties."
      },
      {
        "id" : "PatientInfo.registrationDateTime",
        "path" : "PatientInfo.registrationDateTime",
        "short" : "Date-Time information was entered",
        "definition" : "Date and Time when the patient information was entered into DHIS2",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "dateTime"
          }
        ]
      },
      {
        "id" : "PatientInfo.firstregisteredAt",
        "path" : "PatientInfo.firstregisteredAt",
        "short" : "The Org unit where the patient was first registered",
        "definition" : "The Org unit where the patient was first registered",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id" : "PatientInfo.firstName",
        "path" : "PatientInfo.firstName",
        "short" : "Given name of the patient",
        "definition" : "Given name of the patient",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.lastName",
        "path" : "PatientInfo.lastName",
        "short" : "Family name",
        "definition" : "Family name",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.dateOfBirth",
        "path" : "PatientInfo.dateOfBirth",
        "short" : "...",
        "definition" : "...",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.dateOfBirthIsEstimated",
        "path" : "PatientInfo.dateOfBirthIsEstimated",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "boolean"
          }
        ]
      },
      {
        "id" : "PatientInfo.sexAtBirth",
        "path" : "PatientInfo.sexAtBirth",
        "short" : "...",
        "definition" : "...",
        "comment" : "(valueset depends on the program)",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "https://dhis2.org/ValueSet/patient-sex-at-birth-vs"
        }
      },
      {
        "id" : "PatientInfo.currentHomeAddress",
        "path" : "PatientInfo.currentHomeAddress",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.contactPhoneNumber",
        "path" : "PatientInfo.contactPhoneNumber",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.countryOfBirth",
        "path" : "PatientInfo.countryOfBirth",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "urn:iso:std:iso:3166"
        }
      },
      {
        "id" : "PatientInfo.nationaId",
        "path" : "PatientInfo.nationaId",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "PatientInfo.consent",
        "path" : "PatientInfo.consent",
        "short" : "...",
        "definition" : "...",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "boolean"
          }
        ]
      }
    ]
  }
}