UMC IDMP Request and Publish API
0.1.0 - CI Build

UMC IDMP Request and Publish API, published by Uppsala Monitoring Centre. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/ and changes regularly. See the Directory of published versions

## Extension: Parent PhP

Official URL: http://who-umc.org/idmp/StructureDefinition/parent-phpid | Version: 0.1.0
Active as of 2025-11-19 | Computable Name: ParentPhp

This extension applies to the ADP resource and is used to refer the parent ADPs representing the upper level PhP.

Context of Use

This extension may be used on the following element(s)

- Element ID: `AdministrableProductDefinition`

Usage info

Usages:

- Use this Extension: AdministrableProductDefinition (WHO PhP)
- Examples for this Extension: AdministrableProductDefinition/6C4563BB76BE7967594979196EC91CD8, AdministrableProductDefinition/8195D4AF1287CCE3442C2F308F61DBBC and AdministrableProductDefinition/91B3CA582581F57E4092F13AAF476215
- Search Parameters using this Extension: parent-php

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Parent PhP
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://who-umc.org/idmp/StructureDefinition/parent-phpid"
value[x] |  | 0..1 | Reference(AdministrableProductDefinition (WHO PhP)) | Value of extension
identifier |  | 1..1 | Identifier | Logical reference, when literal reference is not known
system |  | 1..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/phpid
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Parent PhP
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://who-umc.org/idmp/StructureDefinition/parent-phpid"
value[x] |  | 0..1 | Reference(AdministrableProductDefinition (WHO PhP)) | Value of extension
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ C | 1..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/phpid
value | Σ C | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ C | 0..1 | string | Text alternative for the resource
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Reference: This extension applies to the ADP resource and is used to refer the parent ADPs representing the upper level PhP.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Parent PhP
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://who-umc.org/idmp/StructureDefinition/parent-phpid"
value[x] |  | 0..1 | Reference(AdministrableProductDefinition (WHO PhP)) | Value of extension
identifier |  | 1..1 | Identifier | Logical reference, when literal reference is not known
system |  | 1..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/phpid
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Parent PhP
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://who-umc.org/idmp/StructureDefinition/parent-phpid"
value[x] |  | 0..1 | Reference(AdministrableProductDefinition (WHO PhP)) | Value of extension
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ C | 1..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/phpid
value | Σ C | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ C | 0..1 | string | Text alternative for the resource
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Reference: This extension applies to the ADP resource and is used to refer the parent ADPs representing the upper level PhP.

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x].type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std.
Extension.value[x].identifier.​use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std.
Extension.value[x].identifier.​type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`