Versions Compared

Key

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

...

OrgUnit Attribute

Value Type

Description

Example

OU Location Area

Text

Area where the facility is located

Area1

OU Location Sub-Area

Text

SubArea where the facility is located

subArea1

OU Locator Type

Text | Enum

Defines if the organization unit is an outlet or provider

outlet / provider

OU Outlet Type

Text

Defines the type of facility

Public

OU Opening Hours

JSON

Defines the office hours for the facility

Brief FHIR documents here:
Location - FHIR v4.3.0 (hl7.org)

syntax:

Code Block
languagejson
[
  {
    "daysOfWeek": [
    {  "day"
    ],
    "valueopeningTime": "mon" }hh:mm:ss",
    { "valueclosingTime": "tue" },hh:mm:ss"
  }
]

example:

Code Block
languagejson
[
    {
"value      "daysOfWeek": "wed" }[
        "mon",
        "tue",
    {    "value":wed",
        "thu" },
        "fri"
      ],
    {  "valueopeningTime": "fri08:00:00",
}    ],  "closingTime": "validFrom": { "value": "2019-01-01" },
  "validTo": { "value": "2021-12-31" },18:00:00"
    }
]

example:

Code Block
languagejson
[
    {
      "daysOfWeek": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri"
      ],
      "openingTime": "08:00: {00",
      "valueclosingTime": "0917:00:00"
    },
    {
      "daysOfWeek": [
        "sat"
      ],
      "closingTimeopeningTime": {"09:00:00",
      "valueclosingTime": "1712:00:00"
    }
}  ]

OU Services

Text (comma separated)

List of services offered by the facility (excluding Contraceptives services)

COV

OU Contraceptives

Text (comma separated)

List of contraceptives services offered by the facility

IUD,IMP

OU Social.WA

Text

Whatsapp number for the facility

977 984123456

OU Social.FB

Text

FB url for the facility

https://www.facebook.com/orgunit

OU Tags

Text (comma separated)

These tags are used to categorized the facility in various ways. For example by projects

proj1,proj2

...

View file
namemetadata.json

OR

  1. You can follow this link http://localhost:8181/dhis2_configuration

  2. It will ask for the DHIS2 URL where you have hosted your dhis2 instance and also ask for your username and password to successfully connect to the server.

  3. Once connected, it will populate the list of organisation unit attribute created in your system. In another section it will also show, the list of organisation unit attribute need to be created.

  4. If you select the orgunit attribute you want to create and click ‘Proceed', the application will create the orgunit attributes for you.

Mapping your attribute to the API output parameters

...

Mapping Attributes UID

Once you import the orgUnit attributes, you can either go to DHIS2>Maintenance>Other>Attributes and check if the recently imported orgUnit attributes are there or you can use following DHIS2 API to verify the import.

https://{{dhis2_url}}/api/attributes.json?fields=id,name&filter=organisationUnitAttribute:eq:true

Once the attributes are imported, please provide the uid of these attributes in the .env file.

Code Block
#organisationUnit attributes
dhis2.attribute.locatorType=Rjmbgpc7Fdx
dhis2.attribute.outletType=NtzCfaijlfH
dhis2.attribute.openingHours=Wyj3CeyDcy0
dhis2.attribute.area=kE52FSxabWP
dhis2.attribute.subArea=hSSEk8Lgs9w
dhis2.attribute.services=kifmcFtUNql
dhis2.attribute.contraception=mQizDsaeEGi
dhis2.attribute.fb=AjIOJ88gOaE
dhis2.attribute.whatsapp=fN5GReisc6D
dhis2.attribute.tags=YqU4wJJTBLD

These uIds will be used by the application to generate the responses.