Perfil de la unidad organizativa¶

El recurso perfil de la unidad organizativa permite definir y recuperar un perfil de información para las unidades organizativas en DHIS 2.

/api/organisationUnitProfile

Se puede crear un único perfil de unidad organizativa y se aplica a todas las unidades organizativas.

La parte de información del perfil de la unidad organizativa incluye:

• Nombre, nombre corto, descripción, unidad organizativa padre, fecha de apertura, fecha de cierre, URL.
• Persona de contacto, dirección, correo electrónico, número de teléfono (si existe).
• Ubicación (longitud/latitud).
• Atributos de metadatos (configurables).
• Sets de grupos de unidad organizativa y grupos (configurables).
• Datos agregados para elementos de datos, indicadores, tasas de informes, indicadores de programa (configurables).

Crear perfil de la unidad organizativa¶

Para definir el perfil de la unidad organizativa, puede utilizar una petición POST:

POST /api/organisationUnitProfile

The payload in JSON format looks like this, where attributes refers to metadata attributes, groupSets refer to organisation unit group sets and dataItems refers to data elements, indicators, data sets and program indicators:

{
  "attributes": [
    "xqWyz9jNCA5",
    "n2xYlNbsfko"
  ],
  "groupSets": [
    "Bpx0589u8y0",
    "J5jldMd8OHv"
  ],
  "dataItems": [
    "WUg3MYWQ7pt",
    "vg6pdjObxsm",
    "DTVRnCGamkV",
    "Uvn6LCg7dVU",
    "eTDtyyaSA7f"
  ]
}

La autoridad F_ORG_UNIT_PROFILE_ADD es requerida para definir el perfil.

Obtener perfil de la unidad organizativa¶

Para recuperar la definición del perfil de la unidad organizativa, puede utilizar una petición GET:

GET /api/organisationUnitProfile

La respuesta estará en formato JSON.

Obtener datos de perfil de la unidad organizativa¶

Para recuperar los datos del perfil de la unidad organizativa puede utilizar una petición GET:

GET /api/organisationUnitProfile/{org-unit-id}/data?period={iso-period}

El endpoint de los datos del perfil de la unidad organizativa combinará la definición del perfil con los valores de información/datos asociados.

• La variable de ruta org-unit-id es obligatoria y hace referencia al ID de la unidad organizativa para la que se proporcionan datos agregados.
• El parámetro de consulta iso-period es opcional y hace referencia al ID de periodo ISO para que el periodo proporcione datos agregados para los elementos de datos. Si no se especifica ninguno, el período relativo este año se utilizará como alternativa.

La respuesta incluirá las siguientes secciones:

• info: Información fija sobre la unidad organizativa.
• attributes: Atributos de metadatos con los valores de atributos correspondientes.
• groupSets: Sets de grupos de unidad organizativa con el correspondiente grupo de unidades organizativas del que es miembro la unidad organizativa.
• dataItems: Elementos de datos con el correspondiente valor de datos agregados.

Tenga en cuenta que se realizan comprobaciones de control de acceso y se omitirán los elementos de metadatos que no son accesibles para el usuario actual.

Una ejemplo de petición se ve así:

GET /api/organisationUnitProfile/DiszpKrYNg8/data?period=2021

La carga útil de la respuesta de datos del perfil en formato JSON se verá así, donde los campos id y label se refieren al elemento de metadatos, y el campo value se refiere al valor asociado:

{
  "info": {
    "id": "DiszpKrYNg8",
    "code": "OU_559",
    "name": "Ngelehun CHC",
    "shortName": "Ngelehun CHC",
    "parentName": "Badjia",
    "level": 4,
    "levelName": "Facility",
    "openingDate": "1970-01-01T00:00:00.000",
    "longitude": -11.4197,
    "latitude": 8.1039
  },
  "attributes": [
    {
      "id": "n2xYlNbsfko",
      "label": "NGO ID",
      "value": "GHE51"
    },
    {
      "id": "xqWyz9jNCA5",
      "label": "TZ code",
      "value": "NGE54"
    }
  ],
  "groupSets": [
    {
      "id": "Bpx0589u8y0",
      "label": "Facility Ownership",
      "value": "Public facilities"
    },
    {
      "id": "J5jldMd8OHv",
      "label": "Facility Type",
      "value": "CHC"
    }
  ],
  "dataItems": [
    {
      "id": "WUg3MYWQ7pt",
      "label": "Total Population",
      "value": 3503
    },
    {
      "id": "DTVRnCGamkV",
      "label": "Total population < 1 year",
      "value": 140
    },
    {
      "id": "vg6pdjObxsm",
      "label": "Population of women of child bearing age (WRA)",
      "value": 716
    },
    {
      "id": "Uvn6LCg7dVU",
      "label": "ANC 1 Coverage",
      "value": 368.2
    },
    {
      "id": "eTDtyyaSA7f",
      "label": "FIC <1y",
      "value": 291.4
    }
  ]
}

Upload image for organisation unit¶

Para subir una imagen para una unidad organizativa, puede utilizar el endpoint fileResources.

/api/fileResources

El endpoint fileResource acepta un archivo sin formato como cuerpo de la solicitud. Los formatos JPG, JPEG y PNG son compatibles con las imágenes de la unidad organizativa. El dominio para imágenes de la unidad organizativa es ORG_UNIT.

Please consult File resources in the Metadata section for details about the fileResources endpoint.

Para subir una imagen, puede enviar una petición POST con ORG_UNIT como parámetro de consulta de dominio junto con la imagen como parte de los datos de la petición. El encabezado Content-Type debe coincidir con el tipo de archivo que se sube.

POST /api/fileResources?domain=ORG_UNIT

La propiedad id del objeto response > fileResource en la respuesta JSON contendrá una referencia al identificador del recurso de archivo.

La entidad de la unidad de organización tiene una propiedad image que hace referencia a la imagen del recurso del archivo. Para establecer la referencia del recurso del archivo en una unidad organizativa, puede enviar una solicitud PATCH a la unidad organizativa con una carga JSON:

PATCH /api/organisationUnits/{id}

{ 
  "image": "{file-resource-id}" 
}

Como alternativa, puede utilizar una petición PUT con la carga útil completa de la unidad organizativa (los campos se omiten por razones de brevedad):

PUT /api/organisationUnits/{id}

{
  "id": "Rp268JB6Ne4",
  "name": "Adonkia CHP",
  "image": {
    "id":  "{file-resource-iid}"
  }
}

Get image for organisation unit¶

La entidad de unidad de organización tiene un objeto de image que refiere a un recurso de archivo por identificador. Puede obtener la información de la unidad organizativa desde el endpoint organizationUnits. Si se establece, el formato JSON se ve así:

GET /api/organisationUnits/{id}

{
  "id": "Rp268JB6Ne4",
  "name": "Adonkia CHP",
  "image": {
    "id":  "{file-resource-id}"
  }
}

El identificador de recurso del archivo de imagen se puede utilizar para realizar una petición endpoint fileResources para recuperar el contenido del archivo:

GET /api/fileResources/{id}/data

El encabezado Content-Type reflejará el tipo de archivo que se está recuperando.