Uzbekistan Digital Health Platform
0.5.0 - ci-build Uzbekistan flag

Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions

Resource Profile: UZ Core HealthcareService ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-healthcareservice Version: 0.5.0
Active as of 2025-03-11 Computable Name: UZCoreHealthcareService

Uzbekistan Core HealthcareService profile, used to define healthcare services available

UZ Core HealthcareService describes a service that an Organization offers at a Location. It has two jobs in the Digital Health Platform: routing referrals to the right provider, and acting as the catalogue of available laboratory tests - its category and type connect to the laboratory test and result definitions. A PractitionerRole can also point to the service a professional delivers.

Mandatory and Must Support data elements

The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all are required, but your system must populate each Must Support element when it has the data and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types, and terminology bindings.

Each UZ Core HealthcareService Must Have

The base FHIR HealthcareService has no mandatory elements, and this profile does not add any. In practice you will populate the name, category, and type together (see Must Support below).

Each UZ Core HealthcareService Must Support

  • the active flag;
  • a name for the service;
  • a category - coded into either the DHP service category slice or the laboratory category slice (each bound to its national value set);
  • a type - coded into either the DHP service slice or the laboratory test slice (each bound to its national value set).

Use the laboratory category/type slices when the service is a lab test in the catalogue, and the DHP service slices for clinical services - populate the slice that matches, not both.

Building the JSON, step by step

The examples below go from the smallest instance the server will accept to a full catalogue entry with translated names. Copy one and adapt it - every value shown validates against this profile. The complete reference instance is the example HealthcareService.

The smallest HealthcareService you should send

This profile and the base resource add no mandatory elements, so the absolute minimum is just the profile claim in meta.profile. That is not useful on its own - always send the active flag and a name so the entry is identifiable in the catalogue. To make the service routable for referrals or classifiable as a lab test, add the category and type shown next:

{
  "resourceType": "HealthcareService",
  "meta": {
    "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-healthcareservice"]
  },
  "active": true,
  "name": "IHC-ga xos"
}

The active flag says whether the service is currently offered; set it to false to retire an entry from the catalogue without deleting it.

A DHP clinical service

For a clinical service, add the category and type. Both are sliced on the coding system: the DHP slices use the cancer-types-cs system, with category carrying the service category and type the specific service. The system URI is what selects the slice, so it must match exactly:

{
  "resourceType": "HealthcareService",
  "meta": {
    "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-healthcareservice"]
  },
  "active": true,
  "name": "IHC-ga xos",
  "category": [
    {
      "coding": [
        { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs", "code": "cancr0013.00000" }
      ]
    }
  ],
  "type": [
    {
      "coding": [
        { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs", "code": "cancr0013.00001" }
      ]
    }
  ]
}

The category and type codes are bound to national value sets (required binding) - category to ServiceCategoriesVS and type to ServiceNamesVS; the value must come from the bound set. See Terminology for how the national code systems are sourced.

A laboratory test in the catalogue

Laboratory services are catalogued through a dedicated lab slice on category and type. That slice is still being finalized - the lab type code system is not yet published - so a complete JSON example for lab services will be added here once the terminology is in place. Until then, model services with the DHP slice shown above.

Names in more than one language

The platform serves Uzbek, Russian and Karakalpak. The name holds the authoritative Uzbek text; translations travel as a translation extension on the _name companion element (note the leading underscore - that is where FHIR puts extensions on a primitive). Each translation pairs a lang code with the translated content:

"name": "IHC-ga xos",
"_name": {
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/translation",
      "extension": [
        { "url": "lang", "valueCode": "ru" },
        { "url": "content", "valueString": "ИГХ специфические" }
      ]
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/translation",
      "extension": [
        { "url": "lang", "valueCode": "kaa" },
        { "url": "content", "valueString": "IHC ushın arnawlı" }
      ]
    }
  ]
}

The name carries the authoritative Uzbek text; the _name companion holds its Russian and Karakalpak translations, paired field-by-field. Add one translation extension per language you hold.

For example API calls and a sample payload, see the Quick Start at the bottom of this page.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService(5.0.0) The details of a healthcare service available at a location
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... category SΣ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpCategory SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceCategoriesVS (0.5.0) (required)
..... coding:labCategory SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/lab-categories-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: LabServiceCategoriesVS (0.5.0) (required)
... type SΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpService SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceNamesVS (0.5.0) (required)
..... coding:labService SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/observation-lab-research-codes-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ObservationCodesVS (0.5.0) (required)
... name SΣ 0..1 string Description of service as presented to a consumer while searching

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.category Base example Service Category 📍5.0.0 FHIR Std.
HealthcareService.category.​coding:dhpCategory.code Base required Categories of cancer-related services 📍0.5.0 This IG
HealthcareService.category.​coding:labCategory.code Base required Uzbekistan Laboratory Service Categories ValueSet 📍0.5.0 This IG
HealthcareService.type Base example Service Type 📍5.0.0 FHIR Std.
HealthcareService.type.​coding:dhpService.code Base required Cancer-related services 📍0.5.0 This IG
HealthcareService.type.​coding:labService.code Base required Observation codes 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error HealthcareService.implicitRules, HealthcareService.modifierExtension, HealthcareService.active, HealthcareService.category, HealthcareService.category.coding, HealthcareService.category.coding:dhpCategory, HealthcareService.category.coding:dhpCategory.system, HealthcareService.category.coding:dhpCategory.code, HealthcareService.category.coding:labCategory, HealthcareService.category.coding:labCategory.system, HealthcareService.category.coding:labCategory.code, HealthcareService.type, HealthcareService.type.coding, HealthcareService.type.coding:dhpService, HealthcareService.type.coding:dhpService.system, HealthcareService.type.coding:dhpService.code, HealthcareService.type.coding:labService, HealthcareService.type.coding:labService.system, HealthcareService.type.coding:labService.code, HealthcareService.name All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error HealthcareService.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService(5.0.0) The details of a healthcare service available at a location
... active S 0..1 boolean Whether this HealthcareService record is in active use
... category S 0..* CodeableConcept Broad category of service being performed or delivered
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpCategory S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: ServiceCategoriesVS (0.5.0) (required)
..... coding:labCategory S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/lab-categories-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: LabServiceCategoriesVS (0.5.0) (required)
... type S 0..* CodeableConcept Type of service that may be delivered or performed
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpService S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: ServiceNamesVS (0.5.0) (required)
..... coding:labService S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/observation-lab-research-codes-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: ObservationCodesVS (0.5.0) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.category.​coding:dhpCategory.code Base required Categories of cancer-related services 📍0.5.0 This IG
HealthcareService.category.​coding:labCategory.code Base required Uzbekistan Laboratory Service Categories ValueSet 📍0.5.0 This IG
HealthcareService.type.​coding:dhpService.code Base required Cancer-related services 📍0.5.0 This IG
HealthcareService.type.​coding:labService.code Base required Observation codes 📍0.5.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService(5.0.0) The details of a healthcare service available at a location
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier External identifiers for this item
... active ?!SΣ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 0..1 Reference(Organization) Organization that provides this service
... offeredIn 0..* Reference(HealthcareService) The service within which this service is offered
... category SΣ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpCategory SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceCategoriesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:labCategory SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/lab-categories-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: LabServiceCategoriesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... type SΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpService SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceNamesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:labService SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/observation-lab-research-codes-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ObservationCodesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name SΣ 0..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 markdown Additional description and/or any specific issues not covered elsewhere
... extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
... photo Σ 0..1 Attachment Facilitates quick identification of the service
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).
... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter

... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource.
... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.category Base example Service Category 📍5.0.0 FHIR Std.
HealthcareService.category.​coding:dhpCategory.code Base required Categories of cancer-related services 📍0.5.0 This IG
HealthcareService.category.​coding:labCategory.code Base required Uzbekistan Laboratory Service Categories ValueSet 📍0.5.0 This IG
HealthcareService.type Base example Service Type 📍5.0.0 FHIR Std.
HealthcareService.type.​coding:dhpService.code Base required Cancer-related services 📍0.5.0 This IG
HealthcareService.type.​coding:labService.code Base required Observation codes 📍0.5.0 This IG
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
HealthcareService.serviceProvisionCode Base example Service Provision Conditions 📍5.0.0 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍5.0.0 FHIR Std.
HealthcareService.characteristic Base example Service Mode 📍5.0.0 FHIR Std.
HealthcareService.communication Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.referralMethod Base example Referral Method 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error HealthcareService.meta, HealthcareService.implicitRules, HealthcareService.language, HealthcareService.text, HealthcareService.extension, HealthcareService.modifierExtension, HealthcareService.identifier, HealthcareService.active, HealthcareService.providedBy, HealthcareService.offeredIn, HealthcareService.category, HealthcareService.category.extension, HealthcareService.category.coding, HealthcareService.category.coding:dhpCategory, HealthcareService.category.coding:dhpCategory.extension, HealthcareService.category.coding:dhpCategory.system, HealthcareService.category.coding:dhpCategory.version, HealthcareService.category.coding:dhpCategory.code, HealthcareService.category.coding:dhpCategory.display, HealthcareService.category.coding:dhpCategory.userSelected, HealthcareService.category.coding:labCategory, HealthcareService.category.coding:labCategory.extension, HealthcareService.category.coding:labCategory.system, HealthcareService.category.coding:labCategory.version, HealthcareService.category.coding:labCategory.code, HealthcareService.category.coding:labCategory.display, HealthcareService.category.coding:labCategory.userSelected, HealthcareService.category.text, HealthcareService.type, HealthcareService.type.extension, HealthcareService.type.coding, HealthcareService.type.coding:dhpService, HealthcareService.type.coding:dhpService.extension, HealthcareService.type.coding:dhpService.system, HealthcareService.type.coding:dhpService.version, HealthcareService.type.coding:dhpService.code, HealthcareService.type.coding:dhpService.display, HealthcareService.type.coding:dhpService.userSelected, HealthcareService.type.coding:labService, HealthcareService.type.coding:labService.extension, HealthcareService.type.coding:labService.system, HealthcareService.type.coding:labService.version, HealthcareService.type.coding:labService.code, HealthcareService.type.coding:labService.display, HealthcareService.type.coding:labService.userSelected, HealthcareService.type.text, HealthcareService.specialty, HealthcareService.location, HealthcareService.name, HealthcareService.comment, HealthcareService.extraDetails, HealthcareService.photo, HealthcareService.contact, HealthcareService.coverageArea, HealthcareService.serviceProvisionCode, HealthcareService.eligibility, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.eligibility.code, HealthcareService.eligibility.comment, HealthcareService.program, HealthcareService.characteristic, HealthcareService.communication, HealthcareService.referralMethod, HealthcareService.appointmentRequired, HealthcareService.availability, HealthcareService.endpoint All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error HealthcareService.extension, HealthcareService.modifierExtension, HealthcareService.category.extension, HealthcareService.category.coding:dhpCategory.extension, HealthcareService.category.coding:labCategory.extension, HealthcareService.type.extension, HealthcareService.type.coding:dhpService.extension, HealthcareService.type.coding:labService.extension, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(8 nested mandatory elements)
Must-Support: 16 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of HealthcareService.category.coding
  • The element 1 is sliced based on the value of HealthcareService.type.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService(5.0.0) The details of a healthcare service available at a location
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... category SΣ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpCategory SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceCategoriesVS (0.5.0) (required)
..... coding:labCategory SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/lab-categories-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: LabServiceCategoriesVS (0.5.0) (required)
... type SΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpService SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceNamesVS (0.5.0) (required)
..... coding:labService SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/observation-lab-research-codes-cs
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ObservationCodesVS (0.5.0) (required)
... name SΣ 0..1 string Description of service as presented to a consumer while searching

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.category Base example Service Category 📍5.0.0 FHIR Std.
HealthcareService.category.​coding:dhpCategory.code Base required Categories of cancer-related services 📍0.5.0 This IG
HealthcareService.category.​coding:labCategory.code Base required Uzbekistan Laboratory Service Categories ValueSet 📍0.5.0 This IG
HealthcareService.type Base example Service Type 📍5.0.0 FHIR Std.
HealthcareService.type.​coding:dhpService.code Base required Cancer-related services 📍0.5.0 This IG
HealthcareService.type.​coding:labService.code Base required Observation codes 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error HealthcareService.implicitRules, HealthcareService.modifierExtension, HealthcareService.active, HealthcareService.category, HealthcareService.category.coding, HealthcareService.category.coding:dhpCategory, HealthcareService.category.coding:dhpCategory.system, HealthcareService.category.coding:dhpCategory.code, HealthcareService.category.coding:labCategory, HealthcareService.category.coding:labCategory.system, HealthcareService.category.coding:labCategory.code, HealthcareService.type, HealthcareService.type.coding, HealthcareService.type.coding:dhpService, HealthcareService.type.coding:dhpService.system, HealthcareService.type.coding:dhpService.code, HealthcareService.type.coding:labService, HealthcareService.type.coding:labService.system, HealthcareService.type.coding:labService.code, HealthcareService.name All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error HealthcareService.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService(5.0.0) The details of a healthcare service available at a location
... active S 0..1 boolean Whether this HealthcareService record is in active use
... category S 0..* CodeableConcept Broad category of service being performed or delivered
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpCategory S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: ServiceCategoriesVS (0.5.0) (required)
..... coding:labCategory S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/lab-categories-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: LabServiceCategoriesVS (0.5.0) (required)
... type S 0..* CodeableConcept Type of service that may be delivered or performed
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpService S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: ServiceNamesVS (0.5.0) (required)
..... coding:labService S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/observation-lab-research-codes-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: ObservationCodesVS (0.5.0) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.category.​coding:dhpCategory.code Base required Categories of cancer-related services 📍0.5.0 This IG
HealthcareService.category.​coding:labCategory.code Base required Uzbekistan Laboratory Service Categories ValueSet 📍0.5.0 This IG
HealthcareService.type.​coding:dhpService.code Base required Cancer-related services 📍0.5.0 This IG
HealthcareService.type.​coding:labService.code Base required Observation codes 📍0.5.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService(5.0.0) The details of a healthcare service available at a location
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier External identifiers for this item
... active ?!SΣ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 0..1 Reference(Organization) Organization that provides this service
... offeredIn 0..* Reference(HealthcareService) The service within which this service is offered
... category SΣ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpCategory SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceCategoriesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:labCategory SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/lab-categories-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: LabServiceCategoriesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... type SΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:dhpService SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/cancer-types-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ServiceNamesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:labService SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://terminology.dhp.uz/fhir/core/CodeSystem/observation-lab-research-codes-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
Binding: ObservationCodesVS (0.5.0) (required)
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name SΣ 0..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 markdown Additional description and/or any specific issues not covered elsewhere
... extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
... photo Σ 0..1 Attachment Facilitates quick identification of the service
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).
... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter

... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource.
... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.category Base example Service Category 📍5.0.0 FHIR Std.
HealthcareService.category.​coding:dhpCategory.code Base required Categories of cancer-related services 📍0.5.0 This IG
HealthcareService.category.​coding:labCategory.code Base required Uzbekistan Laboratory Service Categories ValueSet 📍0.5.0 This IG
HealthcareService.type Base example Service Type 📍5.0.0 FHIR Std.
HealthcareService.type.​coding:dhpService.code Base required Cancer-related services 📍0.5.0 This IG
HealthcareService.type.​coding:labService.code Base required Observation codes 📍0.5.0 This IG
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
HealthcareService.serviceProvisionCode Base example Service Provision Conditions 📍5.0.0 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍5.0.0 FHIR Std.
HealthcareService.characteristic Base example Service Mode 📍5.0.0 FHIR Std.
HealthcareService.communication Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.referralMethod Base example Referral Method 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error HealthcareService.meta, HealthcareService.implicitRules, HealthcareService.language, HealthcareService.text, HealthcareService.extension, HealthcareService.modifierExtension, HealthcareService.identifier, HealthcareService.active, HealthcareService.providedBy, HealthcareService.offeredIn, HealthcareService.category, HealthcareService.category.extension, HealthcareService.category.coding, HealthcareService.category.coding:dhpCategory, HealthcareService.category.coding:dhpCategory.extension, HealthcareService.category.coding:dhpCategory.system, HealthcareService.category.coding:dhpCategory.version, HealthcareService.category.coding:dhpCategory.code, HealthcareService.category.coding:dhpCategory.display, HealthcareService.category.coding:dhpCategory.userSelected, HealthcareService.category.coding:labCategory, HealthcareService.category.coding:labCategory.extension, HealthcareService.category.coding:labCategory.system, HealthcareService.category.coding:labCategory.version, HealthcareService.category.coding:labCategory.code, HealthcareService.category.coding:labCategory.display, HealthcareService.category.coding:labCategory.userSelected, HealthcareService.category.text, HealthcareService.type, HealthcareService.type.extension, HealthcareService.type.coding, HealthcareService.type.coding:dhpService, HealthcareService.type.coding:dhpService.extension, HealthcareService.type.coding:dhpService.system, HealthcareService.type.coding:dhpService.version, HealthcareService.type.coding:dhpService.code, HealthcareService.type.coding:dhpService.display, HealthcareService.type.coding:dhpService.userSelected, HealthcareService.type.coding:labService, HealthcareService.type.coding:labService.extension, HealthcareService.type.coding:labService.system, HealthcareService.type.coding:labService.version, HealthcareService.type.coding:labService.code, HealthcareService.type.coding:labService.display, HealthcareService.type.coding:labService.userSelected, HealthcareService.type.text, HealthcareService.specialty, HealthcareService.location, HealthcareService.name, HealthcareService.comment, HealthcareService.extraDetails, HealthcareService.photo, HealthcareService.contact, HealthcareService.coverageArea, HealthcareService.serviceProvisionCode, HealthcareService.eligibility, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.eligibility.code, HealthcareService.eligibility.comment, HealthcareService.program, HealthcareService.characteristic, HealthcareService.communication, HealthcareService.referralMethod, HealthcareService.appointmentRequired, HealthcareService.availability, HealthcareService.endpoint All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error HealthcareService.extension, HealthcareService.modifierExtension, HealthcareService.category.extension, HealthcareService.category.coding:dhpCategory.extension, HealthcareService.category.coding:labCategory.extension, HealthcareService.type.extension, HealthcareService.type.coding:dhpService.extension, HealthcareService.type.coding:labService.extension, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(8 nested mandatory elements)
Must-Support: 16 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of HealthcareService.category.coding
  • The element 1 is sliced based on the value of HealthcareService.type.coding

 

Other representations of profile: CSV, Excel, Schematron

Quick Start

Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates a code system from its value and must be URL-encoded as %7C.

Read a healthcare service by server id

GET [base]/HealthcareService/[id]

Find services - for referral routing or as the lab test catalogue

GET [base]/HealthcareService?organization=Organization/[id]&active=true
GET [base]/HealthcareService?location=Location/[id]
GET [base]/HealthcareService?service-category=[category-code]&service-type=[type-code]
GET [base]/HealthcareService?specialty=[specialty-code]

Create a new healthcare service

POST [base]/HealthcareService
{
  "resourceType": "HealthcareService",
  "meta": {
    "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-healthcareservice" ]
  },
  ...
}

Update an existing healthcare service

PUT [base]/HealthcareService/[id]
If-Match: W/"3"   # the ETag from your last read; 412 if it changed since
{
  "resourceType": "HealthcareService",
  "id": "[id]",
  "meta": {
    "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-healthcareservice" ]
  },
  ...
}

See the CapabilityStatement for the full list of supported search parameters.