Versions Compared

Key

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

DHIS2 API

PSI API

FHIR/ location 4.3

remarks

-

postgresId

resource id

Not required

uid

Status
colourBlue
titledhis2

dhisId

identifier

path

Status
colourBlue
titledhis2

path

identifier

Name

Status
colourBlue
titledhis2

dhisName

name

Short name

Status
colourBlue
titledhis2

outletName

alias

Code

Status
colourBlue
titledhis2

dhisCode

Identifier | Identifier type

OU Facility Code

Status
colourGreen
titlecustom

facilityCode

Identifier

redundant

DO NOT PUT ON METADATA PACK

Description

Status
colourBlue
titledhis2

description

description

Opening date

Status
colourBlue
titledhis2

openingDate

status

Closed date

Status
colourBlue
titledhis2

closedDate

Address

Status
colourBlue
titledhis2

location.address

address

OU Location Area

Status
colourGreen
titlecustom

location.area

Address.state

OU Location Sub-Area

Status
colourGreen
titlecustom

location.subArea

Address.city

Email

Status
colourBlue
titledhis2

email

Telecom code = email

URL

Status
colourBlue
titledhis2

url

Telecom code = url

Phone number

Status
colourBlue
titledhis2

phoneNumber

Telecom or/and Identifier

We may need the value as identifier to be able to do searches.

OU Social.FB

Status
colourGreen
titlecustom

social_fb 

Telecom or/and Identifier

OU Social.WA

Status
colourGreen
titlecustom

social_wa 

Telecom or/and identifier

OU ShowContactInfo

Status
colourGreen
titlecustom

ouShowContactInfo 

Linked resource Consent?

Status
colourYellow
titleGaP ?

Latitude

Status
colourBlue
titledhis2

location.latitude

position.latitude

Longitude

Status
colourBlue
titledhis2

location.longitude

position.longitude

OU Opening Hours

Status
colourGreen
titlecustom

free text → fhir notation

openingHours

Hours of Operation

OU Locator Type

Status
colourGreen
titlecustom

w/ option set

locatorType:

  • Outlet

  • Provider

  • Out+Pro

Location

(1) |___ (m) Practitioner

In FHIR the concepts of Location and Practitioner (PSI’s provider) are separate

OU Outlet Type

Status
colourGreen
titlecustom

w/ option set

outletType

Location.type

FHIR types

For 2.0: DHIS will contain a selected list of FHIR types

OU Group name

Status
colourBlue
titledhis2

orgUnitGroup in an OUGS

OU Services

Status
colourGreen
titlecustom

comma delimited w/ option set

servicesStandard

https://www.hl7.org/fhir/healthcareservice.html

Uses a related FHIR resource

Do not include custom & contraceptive on metadata pack

OU Services-Custom

Status
colourGreen
titlecustom

free text

customServices

servicesCustom

OU Contraceptives

Status
colourGreen
titlecustom

comma delimited w/ option set

ouContraceptives 

OU Tags

Status
colourGreen
titlecustom

free text

ouTags

List resource (4.3)

Group (5.0)

need prototyping

Comment

Status
colourBlue
titledhis2

comment

Not required for location

...

UID of custom attribute

EN label

[+]