FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageuz.dhp.core
Resource TypeOperationDefinition
IdOperationDefinition-person-populate.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/uzinfocom-org/digital-health-ig/OperationDefinition-person-populate.html
URLhttps://dhp.uz/fhir/core/OperationDefinition/person-populate
Version0.8.0
Statusactive
Date2026-08-13
NamePersonPopulate
TitlePopulate a person from state registries by identifier
DescriptionCreates a Person resource from an identity document, populating it with data from the state registries of natural persons. The operation takes the identifier as a `system` + `code` + `value` triple (with `birthDate` where needed), resolves it to a PINFL (NI), and retrieves the citizen's details by that PINFL. The operation is idempotent: if a Person with that PINFL already exists in the system it is returned without calling any external source and without creating a duplicate; otherwise a new Person resource is created with an assigned identifier and version. The operation is invoked at type level (Person/$populate) with POST and a Parameters body. The response is the Person resource itself, not Parameters.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
uz.dhp.core#currentDHPCapabilityStatement

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source


English


Generated Narrative: OperationDefinition person-populate

URL: [base]/Person/$populate

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsystem1..1uri

Identification system of the document (Identifier.system). Permitted values: http://terminology.hl7.org/CodeSystem/v2-0203, https://dhp.uz/fhir/core/sid/pid/uz/ni (PINFL), https://dhp.uz/fhir/core/sid/pid/uz/ppn/local (biometric passport / ID card), https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl (international passport), https://dhp.uz/fhir/core/sid/pid/uz/bct (birth certificate). Passed as valueUri.

INcode1..1code

Document type: NI - PINFL, PPN - passport or ID card, BCT - birth certificate. Passed as valueCode.

INvalue1..1string

Document value: the PINFL for NI, the passport series and number for PPN, the birth certificate series and number for BCT. Passed as valueString.

INbirthDate0..1date

Date of birth in YYYY-MM-DD format. Mandatory when code is PPN, because the PINFL is resolved from the passport together with the date of birth. Optional for the other document types, where it is used as an additional matching criterion. Passed as valueDate.

OUTreturn1..1Person

The Person resource that was created, or the one that already existed, populated with data from the state registries.

The document codes NI (PINFL), PPN (passport / ID card) and BCT (birth certificate) are supported; the case of code does not matter. For NI the value is checked locally for correctness. For PPN the birthDate parameter is mandatory - the PINFL is resolved from the series and number together with the date of birth. For BCT the value is split into series and number, which resolve the PINFL. The system value must be one of the permitted identification systems; an unknown system or code results in an OperationOutcome with code invalid. The citizen's address is requested separately and is optional: if it is unavailable, the Person is still created, but without address details. If the citizen is not found in the external registries, or the data retrieved is invalid, no resource is created and an error is returned. Equivalent operations are defined for Practitioner and Organization.


Russian


Сгенерированный нарратив: OperationDefinition person-populate

URL: [base]/Person/$populate

Параметры

ИспользоватьНаименованиеСфера действияКардинальностьТипПривязкаДокументация
INsystem1..1uri

Identification system of the document (Identifier.system). Permitted values: http://terminology.hl7.org/CodeSystem/v2-0203, https://dhp.uz/fhir/core/sid/pid/uz/ni (PINFL), https://dhp.uz/fhir/core/sid/pid/uz/ppn/local (biometric passport / ID card), https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl (international passport), https://dhp.uz/fhir/core/sid/pid/uz/bct (birth certificate). Passed as valueUri.

INcode1..1code

Document type: NI - PINFL, PPN - passport or ID card, BCT - birth certificate. Passed as valueCode.

INvalue1..1string

Document value: the PINFL for NI, the passport series and number for PPN, the birth certificate series and number for BCT. Passed as valueString.

INbirthDate0..1date

Date of birth in YYYY-MM-DD format. Mandatory when code is PPN, because the PINFL is resolved from the passport together with the date of birth. Optional for the other document types, where it is used as an additional matching criterion. Passed as valueDate.

OUTreturn1..1Person

The Person resource that was created, or the one that already existed, populated with data from the state registries.

The document codes NI (PINFL), PPN (passport / ID card) and BCT (birth certificate) are supported; the case of code does not matter. For NI the value is checked locally for correctness. For PPN the birthDate parameter is mandatory - the PINFL is resolved from the series and number together with the date of birth. For BCT the value is split into series and number, which resolve the PINFL. The system value must be one of the permitted identification systems; an unknown system or code results in an OperationOutcome with code invalid. The citizen's address is requested separately and is optional: if it is unavailable, the Person is still created, but without address details. If the citizen is not found in the external registries, or the data retrieved is invalid, no resource is created and an error is returned. Equivalent operations are defined for Practitioner and Organization.


Uzbek


Generated Narrative: OperationDefinition person-populate

URL: [base]/Person/$populate

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsystem1..1uri

Identification system of the document (Identifier.system). Permitted values: http://terminology.hl7.org/CodeSystem/v2-0203, https://dhp.uz/fhir/core/sid/pid/uz/ni (PINFL), https://dhp.uz/fhir/core/sid/pid/uz/ppn/local (biometric passport / ID card), https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl (international passport), https://dhp.uz/fhir/core/sid/pid/uz/bct (birth certificate). Passed as valueUri.

INcode1..1code

Document type: NI - PINFL, PPN - passport or ID card, BCT - birth certificate. Passed as valueCode.

INvalue1..1string

Document value: the PINFL for NI, the passport series and number for PPN, the birth certificate series and number for BCT. Passed as valueString.

INbirthDate0..1date

Date of birth in YYYY-MM-DD format. Mandatory when code is PPN, because the PINFL is resolved from the passport together with the date of birth. Optional for the other document types, where it is used as an additional matching criterion. Passed as valueDate.

OUTreturn1..1Person

The Person resource that was created, or the one that already existed, populated with data from the state registries.

The document codes NI (PINFL), PPN (passport / ID card) and BCT (birth certificate) are supported; the case of code does not matter. For NI the value is checked locally for correctness. For PPN the birthDate parameter is mandatory - the PINFL is resolved from the series and number together with the date of birth. For BCT the value is split into series and number, which resolve the PINFL. The system value must be one of the permitted identification systems; an unknown system or code results in an OperationOutcome with code invalid. The citizen's address is requested separately and is optional: if it is unavailable, the Person is still created, but without address details. If the citizen is not found in the external registries, or the data retrieved is invalid, no resource is created and an error is returned. Equivalent operations are defined for Practitioner and Organization.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "person-populate",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://dhp.uz/fhir/core/OperationDefinition/person-populate",
  "version": "0.8.0",
  "name": "PersonPopulate",
  "title": "Populate a person from state registries by identifier",
  "status": "active",
  "kind": "operation",
  "experimental": false,
  "date": "2026-08-13",
  "publisher": "Ministry of Health of the Republic of Uzbekistan",
  "_publisher": {
    "extension": [
      {
        "extension": [
          {
            "url": "lang",
            "valueCode": "uz"
          },
          {
            "url": "content",
            "valueString": "O‘zbekiston Respublikasi Sog‘liqni saqlash vazirligi"
          }
        ],
        "url": "http://hl7.org/fhir/StructureDefinition/translation"
      },
      {
        "extension": [
          {
            "url": "lang",
            "valueCode": "ru"
          },
          {
            "url": "content",
            "valueString": "Ministry of Health of the Republic of Uzbekistan"
          }
        ],
        "url": "http://hl7.org/fhir/StructureDefinition/translation"
      }
    ]
  },
  "contact": [
    {
      "name": "Ministry of Health of the Republic of Uzbekistan",
      "telecom": [
        {
          "system": "url",
          "value": "https://gov.uz/en/ssv"
        },
        {
          "system": "email",
          "value": "info@ssv.uz"
        }
      ]
    }
  ],
  "description": "Creates a Person resource from an identity document, populating it with data from the state registries of natural persons. The operation takes the identifier as a `system` + `code` + `value` triple (with `birthDate` where needed), resolves it to a PINFL (NI), and retrieves the citizen's details by that PINFL. The operation is idempotent: if a Person with that PINFL already exists in the system it is returned without calling any external source and without creating a duplicate; otherwise a new Person resource is created with an assigned identifier and version. The operation is invoked at type level (Person/$populate) with POST and a Parameters body. The response is the Person resource itself, not Parameters.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "UZ",
          "display": "Uzbekistan"
        }
      ]
    }
  ],
  "affectsState": true,
  "code": "populate",
  "comment": "The document codes NI (PINFL), PPN (passport / ID card) and BCT (birth certificate) are supported; the case of `code` does not matter. For NI the value is checked locally for correctness. For PPN the `birthDate` parameter is mandatory - the PINFL is resolved from the series and number together with the date of birth. For BCT the value is split into series and number, which resolve the PINFL. The `system` value must be one of the permitted identification systems; an unknown `system` or `code` results in an OperationOutcome with code `invalid`. The citizen's address is requested separately and is optional: if it is unavailable, the Person is still created, but without address details. If the citizen is not found in the external registries, or the data retrieved is invalid, no resource is created and an error is returned. Equivalent operations are defined for Practitioner and Organization.",
  "resource": [
    "Person"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "system",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Identification system of the document (Identifier.system). Permitted values: `http://terminology.hl7.org/CodeSystem/v2-0203`, `https://dhp.uz/fhir/core/sid/pid/uz/ni` (PINFL), `https://dhp.uz/fhir/core/sid/pid/uz/ppn/local` (biometric passport / ID card), `https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl` (international passport), `https://dhp.uz/fhir/core/sid/pid/uz/bct` (birth certificate). Passed as valueUri.",
      "type": "uri"
    },
    {
      "name": "code",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Document type: `NI` - PINFL, `PPN` - passport or ID card, `BCT` - birth certificate. Passed as valueCode.",
      "type": "code"
    },
    {
      "name": "value",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Document value: the PINFL for `NI`, the passport series and number for `PPN`, the birth certificate series and number for `BCT`. Passed as valueString.",
      "type": "string"
    },
    {
      "name": "birthDate",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Date of birth in YYYY-MM-DD format. Mandatory when `code` is `PPN`, because the PINFL is resolved from the passport together with the date of birth. Optional for the other document types, where it is used as an additional matching criterion. Passed as valueDate.",
      "type": "date"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The Person resource that was created, or the one that already existed, populated with data from the state registries.",
      "type": "Person"
    }
  ]
}