Guía de Implmentación FHIR ADRES (Core)
1.0.0 - ci-build Colombia

Guía de Implmentación FHIR ADRES (Core) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Consulta detallada BDUA ($bdua-detalle) - JSON Representation

Active as of 2026-05-20

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "BDUA-detalle",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: DefinicionDeOperacion BDUA-detalle</b></p><a name=\"BDUA-detalle\"> </a><a name=\"hcBDUA-detalle\"> </a><p>URL: [base]/Patient/$bdua-detalle</p><p>Input parameters Profile:<a href=\"StructureDefinition-ParametersQueryBDUA.html\">Parámetros de consulta BDUA</a></p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>identifier</td><td/><td>1..1</td><td/><td/><td><div><p>Criterio de búsqueda: identificación de la persona que desempeña el rol de paciente o usuario del sistema de salud. Contiene el tipo y valor del documento de identificación.</p>\n</div></td></tr><tr><td>IN</td><td>identifier.type</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Criterio de búsqueda: Tipo de documento de identificación</p>\n</div></td></tr><tr><td>IN</td><td>identifier.value</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Criterio de búsqueda: Valor del documento de identificación</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://adres.fhir.guide/OperationDefinition/BDUA-detalle",
  "version" : "1.0.0",
  "name" : "OperationDefinition-BDUA-detalle",
  "title" : "Consulta detallada BDUA ($bdua-detalle)",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-05-20",
  "publisher" : "Administradora de ​los Recursos del Sistema General de Seguridad Social en Salud - ADRES",
  "contact" : [
    {
      "name" : "Administradora de ​los Recursos del Sistema General de Seguridad Social en Salud - ADRES",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.adres.gov.co"
        }
      ]
    }
  ],
  "description" : "La operación `$bdua-detalle` permite consultar la información detallada de afiliación y estado de un usuario en el Sistema General de Seguridad Social en Salud (SGSSS) en Colombia, a través del servicio BDUA (Base de Datos Única de Afiliación). La operación está diseñada para ser utilizada por sistemas de información de salud y aplicaciones que necesiten acceder a los datos de afiliación de los usuarios del SGSSS, garantizando la interoperabilidad y el cumplimiento del estándar internacional HL7 FHIR.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "CO",
          "display" : "Colombia"
        }
      ]
    }
  ],
  "purpose" : "Esta operación no es pública y su uso está restringido a aplicaciones de ADRES y entidades adscritas al Ministerio de Salud y Protección Social de Colombia.\n\n### Input\n\nLa operación `$bdua-detalle` requiere un recurso de tipo `Parameters` como entrada, que contenga los parámetros necesarios para realizar la consulta. Los parámetros esperados son:\n\n- Tipo de documento de identidad del usuario (por ejemplo, CC, CE, TI, etc.).\n- Número o cadena alfanumérica del documento de identidad del usuario.\n\nLa definición del recurso `Parameters` para la operación `$bdua-detalle` se encuentra en el perfil [ParametersQueryBDUA](StructureDefinition-ParametersQueryBDUA.html), que especifica la estructura y los elementos requeridos para la solicitud.\n\n\n### Output\n\nLa respuesta de la operación `$bdua-detalle` es un recurso de tipo `Bundle` que contiene los recursos relacionados con la información de afiliación del usuario consultado. El `Bundle` puede incluir recursos correspondientes a los perfiles [paciente](StructureDefinition-PatientADRES.html), [persona](StructureDefinition-PersonADRES.html), [cobertura de salud](StructureDefinition-CoverageADRES.html) y [EAPBS](StructureDefinition-HealthBenefitPlanAdminOrganizationADRES.html), dependiendo de la información disponible en el BDUA para el usuario consultado.\n\nA diferencia de la operación $bdua, la operación `$bdua-detalle` proporciona información más completa y detallada sobre el usuario consultado, incluyendo datos adicionales sobre la persona que desempeña el rol de paciente o usuario del sistema de salud, así como información más específica sobre las coberturas de salud anteriores y las EAPBS asociadas.\n\n### Interacción\n\nEl siguiente diagrama UML ilustra la interacción entre el cliente que realiza la consulta y el servicio FHIR que proporciona la información de afiliación a través de la operación $bdua:\n\n<div style='text-align:center; padding-top:20px; padding-bottom:20px;'>\n  <img src='bdua-detalle-interaction.svg' alt='Operación $bdua-detalle' />\n</div>\n---  \n\n### Ejemplos:\n\n#### Método y Endpoint\n\n```\nPOST [base]/Patient/$bdua-detalle\n```\n\n#### Cuerpo de la solicitud\n\n```json\n{\n  \"resourceType\": \"Parameters\",\n  \"meta\": {\n    \"profile\": [\n      \"https://fhir.adres.gov.co/core/StructureDefinition/ParametersQueryBDUA\"\n    ]\n  },\n  \"parameter\": [\n    {\n      \"part\": [\n        {\n          \"name\": \"type\",\n          \"valueString\": \"CC\"\n        },\n        {\n          \"name\": \"value\",\n          \"valueString\": \"665544332211\"\n        }\n      ],\n      \"name\": \"identifier\"\n    }\n  ]\n}\n```\n\n#### Cuerpo de la respuesta\n\n```json\n{\n  \"resourceType\": \"Bundle\",\n  \"id\": \"Bundle-Respuesta-bdua-50bdf824\",\n  \"type\": \"searchset\",\n  \"total\": 3,\n  \"entry\": [\n    {\n      \"resource\": {\n        \"resourceType\": \"Patient\",\n        ...\n      }\n    },\n    {\n      \"resource\": {\n        \"resourceType\": \"Person\",\n        ...\n      }\n    },\n    {\n      \"resource\": {\n        \"resourceType\": \"Coverage\",\n        ...\n      }\n    },\n    {\n      \"resource\": {\n        \"resourceType\": \"Coverage\",\n        ...\n      }\n    },\n    ...\n    {\n      \"resource\": {\n        \"resourceType\": \"Organization\",\n        ...\n      }\n    }\n    ...\n    {\n      \"resource\": {\n        \"resourceType\": \"Organization\",\n        ...\n      }\n    }\n  ]\n}\n```\n\n#### Ejemplos de solicitud y respuesta\n\n\n|Solicitud|Respuesta|\n|:--------|:--------|\n|[CC, 665544332211](Parameters-Parameters-ejemplo-1.html)|[Bundle - Daniel Armando Mora Fernández](Bundle-Bundle-Respuesta-bdua-detalle-50bdf824.html)|\n|[CC, 444333222111](Parameters-Parameters-ejemplo-2.html)|[Bundle - Marcela Valencia Michelsen](Bundle-Bundle-Respuesta-bdua-detalle-d01dcf4453e4295.html)|\n|[CC, 112233445566](Parameters-Parameters-ejemplo-3.html)|[Bundle - Gloria María Perea Valencia](Bundle-Bundle-Respuesta-bdua-detalle-508721af.html)|\n|[CC, 222333444](Parameters-Parameters-ejemplo-4.html)|[Bundle- Nicolás Flaminio Mora Cifuentes ](Bundle-Bundle-Respuesta-detalle-bdua-d01dcf44.html)|",
  "affectsState" : false,
  "code" : "bdua-detalle",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "https://fhir.adres.gov.co/core/StructureDefinition/ParametersQueryBDUA",
  "parameter" : [
    {
      "name" : "identifier",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Criterio de búsqueda: identificación de la persona que desempeña el rol de paciente o usuario del sistema de salud. Contiene el tipo y valor del documento de identificación.",
      "part" : [
        {
          "name" : "type",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Criterio de búsqueda: Tipo de documento de identificación",
          "type" : "string"
        },
        {
          "name" : "value",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Criterio de búsqueda: Valor del documento de identificación",
          "type" : "string"
        }
      ]
    }
  ]
}