Uzbekistan Digital Health Platform
0.13.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.13.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 RelatedPerson - Detailed Descriptions

Active as of 2026-11-19

Definitions for the uz-core-relatedperson resource profile

See the documentation on how to interpret the contents of this table

0. RelatedPerson
Definition

Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

ShortA person that is related to a patient, but who is not a direct target of care
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
uzcore-gender-other-2: gender 'other' implies differentiation of the gender indication 'other' (for use in a profile) (gender.exists() and gender = 'other' implies gender.extension('https://dhp.uz/fhir/core/StructureDefinition/gender-other').exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. RelatedPerson.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. RelatedPerson.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. RelatedPerson.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. RelatedPerson.identifier
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on RelatedPerson.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

10. RelatedPerson.identifier.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortЭто используется, если значение отсутствует: например, пациент не имеет паспорта, и нужно указать причину отсутствия.Additional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. RelatedPerson.identifier.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. RelatedPerson.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUseVS (0.13.0)http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/identifier-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. RelatedPerson.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from IdentifierTypeVS (0.13.0)http://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/identifier-type-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. RelatedPerson.identifier:nationalId
Slice NamenationalId
Definition

Identifier for a person within a particular scope.

ShortPINFL of the related personA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. RelatedPerson.identifier:nationalId.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. RelatedPerson.identifier:nationalId.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. RelatedPerson.identifier:nationalId.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "NI",
      "display" : "National unique individual identifier"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="NI"/>
    <display value="National unique individual identifier"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. RelatedPerson.identifier:nationalId.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ni"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ni"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. RelatedPerson.identifier:nationalId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. RelatedPerson.identifier:passportLocal
Slice NamepassportLocal
Definition

Local (internal) passport number, shared by the modern ID card and the older book-form passport. Set use = official for the credential currently in force (typically the ID card) and use = old for a superseded paper passport number.


Identifier for a person within a particular scope.

ShortLocal passport / ID card numberA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. RelatedPerson.identifier:passportLocal.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. RelatedPerson.identifier:passportLocal.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. RelatedPerson.identifier:passportLocal.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PPN",
      "display" : "Passport number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="PPN"/>
    <display value="Passport number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. RelatedPerson.identifier:passportLocal.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/local"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/local"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. RelatedPerson.identifier:passportLocal.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. RelatedPerson.identifier:passportInternational
Slice NamepassportInternational
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. RelatedPerson.identifier:passportInternational.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. RelatedPerson.identifier:passportInternational.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. RelatedPerson.identifier:passportInternational.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PPN",
      "display" : "Passport number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="PPN"/>
    <display value="Passport number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. RelatedPerson.identifier:passportInternational.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. RelatedPerson.identifier:passportInternational.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. RelatedPerson.identifier:birthCertificate
Slice NamebirthCertificate
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. RelatedPerson.identifier:birthCertificate.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
58. RelatedPerson.identifier:birthCertificate.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. RelatedPerson.identifier:birthCertificate.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "BCT",
      "display" : "Birth Certificate"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="BCT"/>
    <display value="Birth Certificate"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. RelatedPerson.identifier:birthCertificate.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/bct"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/bct"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. RelatedPerson.identifier:birthCertificate.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. RelatedPerson.identifier:driversLicense
Slice NamedriversLicense
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. RelatedPerson.identifier:driversLicense.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
70. RelatedPerson.identifier:driversLicense.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. RelatedPerson.identifier:driversLicense.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "DL",
      "display" : "Driver's license number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="DL"/>
    <display value="Driver's license number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. RelatedPerson.identifier:driversLicense.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/dl"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/dl"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. RelatedPerson.identifier:driversLicense.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. RelatedPerson.identifier:diplomaticPassport
Slice NamediplomaticPassport
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. RelatedPerson.identifier:diplomaticPassport.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
82. RelatedPerson.identifier:diplomaticPassport.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. RelatedPerson.identifier:diplomaticPassport.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "DP",
      "display" : "Diplomatic Passport"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="DP"/>
    <display value="Diplomatic Passport"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. RelatedPerson.identifier:diplomaticPassport.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/dp"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/dp"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. RelatedPerson.identifier:diplomaticPassport.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. RelatedPerson.identifier:healthCard
Slice NamehealthCard
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. RelatedPerson.identifier:healthCard.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
94. RelatedPerson.identifier:healthCard.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. RelatedPerson.identifier:healthCard.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "HC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="HC"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. RelatedPerson.identifier:healthCard.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/hc"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/hc"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. RelatedPerson.identifier:healthCard.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. RelatedPerson.identifier:militaryId
Slice NamemilitaryId
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. RelatedPerson.identifier:militaryId.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
106. RelatedPerson.identifier:militaryId.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. RelatedPerson.identifier:militaryId.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control10..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MI",
      "display" : "Military ID number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="MI"/>
    <display value="Military ID number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. RelatedPerson.identifier:militaryId.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/mi"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/mi"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. RelatedPerson.identifier:militaryId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. RelatedPerson.active
Definition

Whether this related person record is in active use.

ShortWhether this related person's record is in active use
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Control0..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. RelatedPerson.patient
Definition

The patient this person is related to.

ShortThe patient this person is related to
Control1..1
TypeReference(UZ Core Patient, Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

We need to know which patient this RelatedPerson is related to.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. RelatedPerson.relationship
Definition

The nature of the relationship between the related person and the patient.

ShortThe relationship of the related person to the patient
Comments

The directionality of the relationship is from the RelatedPerson to the Patient. For example, if the Patient is a child, and the RelatedPerson is the mother, the relationship would be PRN (parent) or MTH (mother).

Control0..*
BindingThe codes SHOULD be taken from RelationshipTypeVS (0.13.0)http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|5.0.0
(preferred to https://terminology.dhp.uz/fhir/core/ValueSet/relationship-type-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on RelatedPerson.relationship. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

120. RelatedPerson.relationship:dhpRelationship
Slice NamedhpRelationship
Definition

The nature of the relationship between the related person and the patient.

ShortRelationship from the national value setThe relationship of the related person to the patient
Comments

The directionality of the relationship is from the RelatedPerson to the Patient. For example, if the Patient is a child, and the RelatedPerson is the mother, the relationship would be PRN (parent) or MTH (mother).

Control0..*
BindingThe codes SHALL be taken from The codes SHOULD be taken from RelationshipTypeVS (0.13.0)http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/relationship-type-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. RelatedPerson.name
Definition

A name associated with the person.

ShortA name associated with the person
Control0..*
TypeHumanName
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. RelatedPerson.name.use
Definition

Identifies the purpose for this name.

Shortusual | official | temp | nickname | anonymous | old | maiden
Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)

The use of a human name.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. RelatedPerson.name.text
Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

ShortText representation of the full name
Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. RelatedPerson.name.family
Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

ShortFamily name (often called 'Surname')
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namessurname
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. RelatedPerson.name.given
Definition

Given name.

ShortGiven names (not always 'first'). Includes middle names
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namesfirst name, middle name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. RelatedPerson.name.suffix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

ShortParts that come after the name
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. RelatedPerson.name.period
Definition

Indicates the period of time when this name was valid for the named person.

ShortTime period when name was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows names to be placed in historical context.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. RelatedPerson.telecom
Definition

A contact detail for the person, e.g. a telephone number or an email address.

ShortA contact detail for the person
Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Control0..*
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. RelatedPerson.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Shortphone | fax | email | pager | url | sms | other
Control0..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystemVS (0.13.0)http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/contact-point-system-vs|0.13.0)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. RelatedPerson.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from TelecomUseVS (0.13.0)http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/telecom-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. RelatedPerson.gender
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Shortmale | female | other | unknown
Control0..1
BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
(required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)

The gender of a person used for administrative purposes.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. RelatedPerson.gender.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.gender.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
146. RelatedPerson.gender.extension:gender-other-2
Slice Namegender-other-2
Definition

Extension for more precise differentiation of the administrative gender 'other', aligned with German base profiles representation of the same concept.

ShortDifferentiation of the administrative gender 'other'
Control0..1
TypeExtension(Differentiation of the administrative gender 'other') (Extension Type: Coding)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
148. RelatedPerson.birthDate
Definition

The date on which the related person was born.

ShortThe date on which the related person was born
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. RelatedPerson.address
Definition

Address where the related person can be contacted or visited.

ShortAddress where the related person can be contacted or visited
Control0..*
TypeAddress
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on RelatedPerson.address. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ country

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

152. RelatedPerson.address:uzAddress
Slice NameuzAddress
Definition

Address where the related person can be contacted or visited.

ShortAn Uzbekistan addressAddress where the related person can be contacted or visited
Control0..*
TypeAddress
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. RelatedPerson.address:uzAddress.use
Definition

The purpose of this address.

ShortType of address, home | temphome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUseVS (0.13.0)http://hl7.org/fhir/ValueSet/address-use|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

ExampleGeneral: home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. RelatedPerson.address:uzAddress.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
BindingThe codes SHALL be taken from AddressTypeVS (0.13.0)http://hl7.org/fhir/ValueSet/address-type|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-type-vs|0.13.0)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. RelatedPerson.address:uzAddress.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText part of the address provided by DPM. Mahalla name, street, house number, apartment numberText representation of the address
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

ExampleGeneral: 137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. RelatedPerson.address:uzAddress.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortText street name provided by DPMStreet name, number, direction & P.O. Box etc.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. RelatedPerson.address:uzAddress.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortMahalla code (citizens' assembly)Name of city, town etc.
Control0..1
BindingThe codes SHALL be taken from For codes, see MahallaVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/mahalla-vs|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
ExampleGeneral: Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. RelatedPerson.address:uzAddress.district
Definition

The name of the administrative area (county).

ShortDistrict or city codeDistrict name (aka county)
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
BindingThe codes SHALL be taken from For codes, see RegionsVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/regions-vs|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesCounty
ExampleGeneral: Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. RelatedPerson.address:uzAddress.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortRegion codeSub-unit of country (abbreviations ok)
Control0..1
BindingThe codes SHALL be taken from For codes, see StateVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/state-vs|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. RelatedPerson.address:uzAddress.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry code (ISO 3166-1 2 letter code)Country (e.g. may be ISO 3166 2 or 3 letter code)
Comments

ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Pattern Value
{
  "country" : "UZ"
}
<country value="UZ"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. RelatedPerson.address:uzAddress.period
Definition

Time period when address was/is in use.

ShortTime period when the address was/is usedTime period when address was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows addresses to be placed in historical context.

ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. RelatedPerson.address:i18nAddress
Slice Namei18nAddress
Definition

Address where the related person can be contacted or visited.

ShortAn international, non-Uzbekistan addressAddress where the related person can be contacted or visited
Control0..*
TypeAddress
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. RelatedPerson.address:i18nAddress.use
Definition

The purpose of this address.

ShortType of address, home | temphome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUseVS (0.13.0)http://hl7.org/fhir/ValueSet/address-use|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

ExampleGeneral: home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. RelatedPerson.address:i18nAddress.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
BindingThe codes SHALL be taken from AddressTypeVS (0.13.0)http://hl7.org/fhir/ValueSet/address-type|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-type-vs|0.13.0)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. RelatedPerson.address:i18nAddress.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText part of the addressText representation of the address
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

ExampleGeneral: 137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. RelatedPerson.address:i18nAddress.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortStreet name or address lineStreet name, number, direction & P.O. Box etc.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
182. RelatedPerson.address:i18nAddress.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortCity or localityName of city, town etc.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
ExampleGeneral: Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. RelatedPerson.address:i18nAddress.district
Definition

The name of the administrative area (county).

ShortDistrict, county, or administrative divisionDistrict name (aka county)
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesCounty
ExampleGeneral: Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. RelatedPerson.address:i18nAddress.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortState, province, or regionSub-unit of country (abbreviations ok)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. RelatedPerson.address:i18nAddress.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry code (ISO 3166-1 2 letter code)Country (e.g. may be ISO 3166 2 or 3 letter code)
Comments

ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

Control10..1
BindingThe codes SHALL be taken from For codes, see ISO3166_2SansUZ (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/iso-3166-2-vs-sans-uz|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. RelatedPerson.address:i18nAddress.period
Definition

Time period when address was/is in use.

ShortTime period when the address was/is usedTime period when address was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows addresses to be placed in historical context.

ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. RelatedPerson.period
Definition

The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

ShortPeriod of time that this relationship is considered valid
Comments

If an individual has a relationship with a patient over multiple, non-adjacent periods, there should be a distinct RelatedPerson instance for each period. For example, if a person is a roommate for a period of time, moves out, and is later a roommate with the same person again, you would have two RelatedPerson instances.

Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. RelatedPerson
Invariantsuzcore-gender-other-2: gender 'other' implies differentiation of the gender indication 'other' (for use in a profile) (gender.exists() and gender = 'other' implies gender.extension('https://dhp.uz/fhir/core/StructureDefinition/gender-other').exists())
2. RelatedPerson.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
Must Supporttrue
SlicingThis element introduces a set of slices on RelatedPerson.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

4. RelatedPerson.identifier.extension
ShortЭто используется, если значение отсутствует: например, пациент не имеет паспорта, и нужно указать причину отсутствия.
6. RelatedPerson.identifier.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
8. RelatedPerson.identifier.use
BindingThe codes SHALL be taken from IdentifierUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/identifier-use-vs|0.13.0)
10. RelatedPerson.identifier.type
BindingThe codes SHALL be taken from IdentifierTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/identifier-type-vs|0.13.0)
12. RelatedPerson.identifier:nationalId
Slice NamenationalId
ShortPINFL of the related person
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Must Supporttrue
14. RelatedPerson.identifier:nationalId.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
16. RelatedPerson.identifier:nationalId.use
Pattern Value
{
  "use" : "official"
}
<use value="official"/>
18. RelatedPerson.identifier:nationalId.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "NI",
      "display" : "National unique individual identifier"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="NI"/>
    <display value="National unique individual identifier"/>
  </coding>
</type>
20. RelatedPerson.identifier:nationalId.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ni"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ni"/>
22. RelatedPerson.identifier:nationalId.value
Control1..?
Must Supporttrue
24. RelatedPerson.identifier:passportLocal
Slice NamepassportLocal
Definition

Local (internal) passport number, shared by the modern ID card and the older book-form passport. Set use = official for the credential currently in force (typically the ID card) and use = old for a superseded paper passport number.

ShortLocal passport / ID card number
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
Must Supporttrue
26. RelatedPerson.identifier:passportLocal.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
28. RelatedPerson.identifier:passportLocal.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PPN",
      "display" : "Passport number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="PPN"/>
    <display value="Passport number"/>
  </coding>
</type>
30. RelatedPerson.identifier:passportLocal.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/local"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/local"/>
32. RelatedPerson.identifier:passportLocal.value
Control1..?
Must Supporttrue
34. RelatedPerson.identifier:passportInternational
Slice NamepassportInternational
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
Must Supporttrue
36. RelatedPerson.identifier:passportInternational.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
38. RelatedPerson.identifier:passportInternational.use
Pattern Value
{
  "use" : "official"
}
<use value="official"/>
40. RelatedPerson.identifier:passportInternational.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PPN",
      "display" : "Passport number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="PPN"/>
    <display value="Passport number"/>
  </coding>
</type>
42. RelatedPerson.identifier:passportInternational.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl"/>
44. RelatedPerson.identifier:passportInternational.value
Control1..?
Must Supporttrue
46. RelatedPerson.identifier:birthCertificate
Slice NamebirthCertificate
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Must Supporttrue
48. RelatedPerson.identifier:birthCertificate.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
50. RelatedPerson.identifier:birthCertificate.use
Pattern Value
{
  "use" : "official"
}
<use value="official"/>
52. RelatedPerson.identifier:birthCertificate.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "BCT",
      "display" : "Birth Certificate"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="BCT"/>
    <display value="Birth Certificate"/>
  </coding>
</type>
54. RelatedPerson.identifier:birthCertificate.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/bct"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/bct"/>
56. RelatedPerson.identifier:birthCertificate.value
Control1..?
Must Supporttrue
58. RelatedPerson.identifier:driversLicense
Slice NamedriversLicense
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Must Supporttrue
60. RelatedPerson.identifier:driversLicense.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
62. RelatedPerson.identifier:driversLicense.use
Pattern Value
{
  "use" : "official"
}
<use value="official"/>
64. RelatedPerson.identifier:driversLicense.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "DL",
      "display" : "Driver's license number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="DL"/>
    <display value="Driver's license number"/>
  </coding>
</type>
66. RelatedPerson.identifier:driversLicense.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/dl"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/dl"/>
68. RelatedPerson.identifier:driversLicense.value
Control1..?
Must Supporttrue
70. RelatedPerson.identifier:diplomaticPassport
Slice NamediplomaticPassport
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Must Supporttrue
72. RelatedPerson.identifier:diplomaticPassport.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
74. RelatedPerson.identifier:diplomaticPassport.use
Pattern Value
{
  "use" : "official"
}
<use value="official"/>
76. RelatedPerson.identifier:diplomaticPassport.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "DP",
      "display" : "Diplomatic Passport"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="DP"/>
    <display value="Diplomatic Passport"/>
  </coding>
</type>
78. RelatedPerson.identifier:diplomaticPassport.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/dp"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/dp"/>
80. RelatedPerson.identifier:diplomaticPassport.value
Control1..?
Must Supporttrue
82. RelatedPerson.identifier:healthCard
Slice NamehealthCard
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Must Supporttrue
84. RelatedPerson.identifier:healthCard.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
86. RelatedPerson.identifier:healthCard.use
Pattern Value
{
  "use" : "official"
}
<use value="official"/>
88. RelatedPerson.identifier:healthCard.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "HC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="HC"/>
  </coding>
</type>
90. RelatedPerson.identifier:healthCard.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/hc"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/hc"/>
92. RelatedPerson.identifier:healthCard.value
Control1..?
Must Supporttrue
94. RelatedPerson.identifier:militaryId
Slice NamemilitaryId
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
Must Supporttrue
96. RelatedPerson.identifier:militaryId.extension:data-absent-reason
Slice Namedata-absent-reason
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Must Supporttrue
98. RelatedPerson.identifier:militaryId.use
Pattern Value
{
  "use" : "official"
}
<use value="official"/>
100. RelatedPerson.identifier:militaryId.type
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MI",
      "display" : "Military ID number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="MI"/>
    <display value="Military ID number"/>
  </coding>
</type>
102. RelatedPerson.identifier:militaryId.system
Control1..?
Must Supporttrue
Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/mi"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/mi"/>
104. RelatedPerson.identifier:militaryId.value
Control1..?
Must Supporttrue
106. RelatedPerson.active
Must Supporttrue
108. RelatedPerson.patient
TypeReference(UZ Core Patient)
Must Supporttrue
110. RelatedPerson.relationship
BindingThe codes SHOULD be taken from RelationshipTypeVS (0.13.0)
(preferred to https://terminology.dhp.uz/fhir/core/ValueSet/relationship-type-vs|0.13.0)
Must Supporttrue
SlicingThis element introduces a set of slices on RelatedPerson.relationship. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

112. RelatedPerson.relationship:dhpRelationship
Slice NamedhpRelationship
ShortRelationship from the national value set
Control0..*
BindingThe codes SHALL be taken from RelationshipTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/relationship-type-vs|0.13.0)
Must Supporttrue
114. RelatedPerson.name
Must Supporttrue
116. RelatedPerson.name.use
Must Supporttrue
118. RelatedPerson.name.text
Must Supporttrue
120. RelatedPerson.name.family
Must Supporttrue
122. RelatedPerson.name.given
Must Supporttrue
124. RelatedPerson.name.suffix
Must Supporttrue
126. RelatedPerson.name.period
Must Supporttrue
128. RelatedPerson.telecom
Must Supporttrue
130. RelatedPerson.telecom.system
BindingThe codes SHALL be taken from ContactPointSystemVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/contact-point-system-vs|0.13.0)
Must Supporttrue
132. RelatedPerson.telecom.use
BindingThe codes SHALL be taken from TelecomUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/telecom-use-vs|0.13.0)
Must Supporttrue
134. RelatedPerson.gender
Must Supporttrue
136. RelatedPerson.gender.extension
SlicingThis element introduces a set of slices on RelatedPerson.gender.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
138. RelatedPerson.gender.extension:gender-other-2
Slice Namegender-other-2
Control0..1
TypeExtension(Differentiation of the administrative gender 'other') (Extension Type: Coding)
Must Supporttrue
140. RelatedPerson.birthDate
Must Supporttrue
142. RelatedPerson.address
Must Supporttrue
SlicingThis element introduces a set of slices on RelatedPerson.address. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ country

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

144. RelatedPerson.address:uzAddress
Slice NameuzAddress
ShortAn Uzbekistan address
Control0..*
Must Supporttrue
146. RelatedPerson.address:uzAddress.use
ShortType of address, home | temp
BindingThe codes SHALL be taken from AddressUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-use-vs|0.13.0)
Must Supporttrue
148. RelatedPerson.address:uzAddress.type
BindingThe codes SHALL be taken from AddressTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-type-vs|0.13.0)
Must Supporttrue
150. RelatedPerson.address:uzAddress.text
ShortText part of the address provided by DPM. Mahalla name, street, house number, apartment number
Must Supporttrue
152. RelatedPerson.address:uzAddress.line
ShortText street name provided by DPM
Must Supporttrue
154. RelatedPerson.address:uzAddress.city
ShortMahalla code (citizens' assembly)
BindingThe codes SHALL be taken from MahallaVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/mahalla-vs|0.13.0)
Must Supporttrue
156. RelatedPerson.address:uzAddress.district
ShortDistrict or city code
BindingThe codes SHALL be taken from RegionsVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/regions-vs|0.13.0)
Must Supporttrue
158. RelatedPerson.address:uzAddress.state
ShortRegion code
BindingThe codes SHALL be taken from StateVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/state-vs|0.13.0)
Must Supporttrue
160. RelatedPerson.address:uzAddress.country
ShortCountry code (ISO 3166-1 2 letter code)
Control1..?
Must Supporttrue
Pattern Value
{
  "country" : "UZ"
}
<country value="UZ"/>
162. RelatedPerson.address:uzAddress.period
ShortTime period when the address was/is used
Must Supporttrue
164. RelatedPerson.address:i18nAddress
Slice Namei18nAddress
ShortAn international, non-Uzbekistan address
Control0..*
Must Supporttrue
166. RelatedPerson.address:i18nAddress.use
ShortType of address, home | temp
BindingThe codes SHALL be taken from AddressUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-use-vs|0.13.0)
Must Supporttrue
168. RelatedPerson.address:i18nAddress.type
BindingThe codes SHALL be taken from AddressTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-type-vs|0.13.0)
Must Supporttrue
170. RelatedPerson.address:i18nAddress.text
ShortText part of the address
Must Supporttrue
172. RelatedPerson.address:i18nAddress.line
ShortStreet name or address line
Must Supporttrue
174. RelatedPerson.address:i18nAddress.city
ShortCity or locality
Must Supporttrue
176. RelatedPerson.address:i18nAddress.district
ShortDistrict, county, or administrative division
Must Supporttrue
178. RelatedPerson.address:i18nAddress.state
ShortState, province, or region
Must Supporttrue
180. RelatedPerson.address:i18nAddress.country
ShortCountry code (ISO 3166-1 2 letter code)
Control1..?
BindingThe codes SHALL be taken from ISO3166_2SansUZ (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/iso-3166-2-vs-sans-uz|0.13.0)
Must Supporttrue
182. RelatedPerson.address:i18nAddress.period
ShortTime period when the address was/is used
Must Supporttrue
184. RelatedPerson.period
Must Supporttrue

See the documentation on how to interpret the contents of this table

0. RelatedPerson
Definition

Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

ShortA person that is related to a patient, but who is not a direct target of care
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
uzcore-gender-other-2: gender 'other' implies differentiation of the gender indication 'other' (for use in a profile) (gender.exists() and gender = 'other' implies gender.extension('https://dhp.uz/fhir/core/StructureDefinition/gender-other').exists())
2. RelatedPerson.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. RelatedPerson.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. RelatedPerson.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. RelatedPerson.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. RelatedPerson.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. RelatedPerson.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. RelatedPerson.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. RelatedPerson.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. RelatedPerson.identifier
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on RelatedPerson.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

20. RelatedPerson.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. RelatedPerson.identifier.extension
Definition

An Extension

ShortЭто используется, если значение отсутствует: например, пациент не имеет паспорта, и нужно указать причину отсутствия.
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. RelatedPerson.identifier.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. RelatedPerson.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/identifier-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. RelatedPerson.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingThe codes SHALL be taken from IdentifierTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/identifier-type-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. RelatedPerson.identifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. RelatedPerson.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. RelatedPerson.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. RelatedPerson.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. RelatedPerson.identifier:nationalId
Slice NamenationalId
Definition

Identifier for a person within a particular scope.

ShortPINFL of the related person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. RelatedPerson.identifier:nationalId.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
42. RelatedPerson.identifier:nationalId.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. RelatedPerson.identifier:nationalId.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. RelatedPerson.identifier:nationalId.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. RelatedPerson.identifier:nationalId.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "NI",
      "display" : "National unique individual identifier"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="NI"/>
    <display value="National unique individual identifier"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. RelatedPerson.identifier:nationalId.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ni"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ni"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. RelatedPerson.identifier:nationalId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. RelatedPerson.identifier:nationalId.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. RelatedPerson.identifier:nationalId.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. RelatedPerson.identifier:passportLocal
Slice NamepassportLocal
Definition

Local (internal) passport number, shared by the modern ID card and the older book-form passport. Set use = official for the credential currently in force (typically the ID card) and use = old for a superseded paper passport number.

ShortLocal passport / ID card number
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. RelatedPerson.identifier:passportLocal.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
62. RelatedPerson.identifier:passportLocal.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. RelatedPerson.identifier:passportLocal.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
66. RelatedPerson.identifier:passportLocal.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. RelatedPerson.identifier:passportLocal.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PPN",
      "display" : "Passport number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="PPN"/>
    <display value="Passport number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. RelatedPerson.identifier:passportLocal.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/local"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/local"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. RelatedPerson.identifier:passportLocal.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. RelatedPerson.identifier:passportLocal.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. RelatedPerson.identifier:passportLocal.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. RelatedPerson.identifier:passportInternational
Slice NamepassportInternational
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. RelatedPerson.identifier:passportInternational.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
82. RelatedPerson.identifier:passportInternational.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
84. RelatedPerson.identifier:passportInternational.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
86. RelatedPerson.identifier:passportInternational.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. RelatedPerson.identifier:passportInternational.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PPN",
      "display" : "Passport number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="PPN"/>
    <display value="Passport number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. RelatedPerson.identifier:passportInternational.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/intl"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. RelatedPerson.identifier:passportInternational.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. RelatedPerson.identifier:passportInternational.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. RelatedPerson.identifier:passportInternational.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. RelatedPerson.identifier:birthCertificate
Slice NamebirthCertificate
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. RelatedPerson.identifier:birthCertificate.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
102. RelatedPerson.identifier:birthCertificate.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
104. RelatedPerson.identifier:birthCertificate.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
106. RelatedPerson.identifier:birthCertificate.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. RelatedPerson.identifier:birthCertificate.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "BCT",
      "display" : "Birth Certificate"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="BCT"/>
    <display value="Birth Certificate"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. RelatedPerson.identifier:birthCertificate.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/bct"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/bct"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. RelatedPerson.identifier:birthCertificate.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. RelatedPerson.identifier:birthCertificate.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. RelatedPerson.identifier:birthCertificate.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. RelatedPerson.identifier:driversLicense
Slice NamedriversLicense
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. RelatedPerson.identifier:driversLicense.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
122. RelatedPerson.identifier:driversLicense.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
124. RelatedPerson.identifier:driversLicense.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
126. RelatedPerson.identifier:driversLicense.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. RelatedPerson.identifier:driversLicense.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "DL",
      "display" : "Driver's license number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="DL"/>
    <display value="Driver's license number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. RelatedPerson.identifier:driversLicense.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/dl"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/dl"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. RelatedPerson.identifier:driversLicense.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. RelatedPerson.identifier:driversLicense.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. RelatedPerson.identifier:driversLicense.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. RelatedPerson.identifier:diplomaticPassport
Slice NamediplomaticPassport
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. RelatedPerson.identifier:diplomaticPassport.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
142. RelatedPerson.identifier:diplomaticPassport.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
144. RelatedPerson.identifier:diplomaticPassport.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
146. RelatedPerson.identifier:diplomaticPassport.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. RelatedPerson.identifier:diplomaticPassport.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "DP",
      "display" : "Diplomatic Passport"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="DP"/>
    <display value="Diplomatic Passport"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. RelatedPerson.identifier:diplomaticPassport.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/ppn/dp"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/ppn/dp"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. RelatedPerson.identifier:diplomaticPassport.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. RelatedPerson.identifier:diplomaticPassport.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. RelatedPerson.identifier:diplomaticPassport.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. RelatedPerson.identifier:healthCard
Slice NamehealthCard
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. RelatedPerson.identifier:healthCard.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
162. RelatedPerson.identifier:healthCard.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
164. RelatedPerson.identifier:healthCard.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
166. RelatedPerson.identifier:healthCard.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. RelatedPerson.identifier:healthCard.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "HC"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="HC"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. RelatedPerson.identifier:healthCard.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/hc"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/hc"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. RelatedPerson.identifier:healthCard.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. RelatedPerson.identifier:healthCard.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. RelatedPerson.identifier:healthCard.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. RelatedPerson.identifier:militaryId
Slice NamemilitaryId
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
Comments

RelatedPerson identifiers might not be unique across instances within a system, as a single human individual may be represented as many different RelatedPerson resources with different roles, periods, or relationships.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. RelatedPerson.identifier:militaryId.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
182. RelatedPerson.identifier:militaryId.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
184. RelatedPerson.identifier:militaryId.extension:data-absent-reason
Slice Namedata-absent-reason
Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
Control0..1
TypeExtension(Data Absent Reason) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
186. RelatedPerson.identifier:militaryId.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Value
{
  "use" : "official"
}
<use value="official"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. RelatedPerson.identifier:militaryId.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MI",
      "display" : "Military ID number"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
    <code value="MI"/>
    <display value="Military ID number"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. RelatedPerson.identifier:militaryId.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Pattern Value
{
  "system" : "https://dhp.uz/fhir/core/sid/pid/uz/mi"
}
<system value="https://dhp.uz/fhir/core/sid/pid/uz/mi"/>
ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. RelatedPerson.identifier:militaryId.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. RelatedPerson.identifier:militaryId.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. RelatedPerson.identifier:militaryId.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. RelatedPerson.active
Definition

Whether this related person record is in active use.

ShortWhether this related person's record is in active use
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Control0..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. RelatedPerson.patient
Definition

The patient this person is related to.

ShortThe patient this person is related to
Control1..1
TypeReference(UZ Core Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

We need to know which patient this RelatedPerson is related to.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
202. RelatedPerson.relationship
Definition

The nature of the relationship between the related person and the patient.

ShortThe relationship of the related person to the patient
Comments

The directionality of the relationship is from the RelatedPerson to the Patient. For example, if the Patient is a child, and the RelatedPerson is the mother, the relationship would be PRN (parent) or MTH (mother).

Control0..*
BindingThe codes SHOULD be taken from RelationshipTypeVS (0.13.0)
(preferred to https://terminology.dhp.uz/fhir/core/ValueSet/relationship-type-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on RelatedPerson.relationship. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

204. RelatedPerson.relationship:dhpRelationship
Slice NamedhpRelationship
Definition

The nature of the relationship between the related person and the patient.

ShortRelationship from the national value set
Comments

The directionality of the relationship is from the RelatedPerson to the Patient. For example, if the Patient is a child, and the RelatedPerson is the mother, the relationship would be PRN (parent) or MTH (mother).

Control0..*
BindingThe codes SHALL be taken from RelationshipTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/relationship-type-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. RelatedPerson.name
Definition

A name associated with the person.

ShortA name associated with the person
Control0..*
TypeHumanName
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. RelatedPerson.name.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
210. RelatedPerson.name.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.name.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
212. RelatedPerson.name.use
Definition

Identifies the purpose for this name.

Shortusual | official | temp | nickname | anonymous | old | maiden
Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from NameUse
(required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)

The use of a human name.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
214. RelatedPerson.name.text
Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

ShortText representation of the full name
Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. RelatedPerson.name.family
Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

ShortFamily name (often called 'Surname')
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namessurname
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. RelatedPerson.name.given
Definition

Given name.

ShortGiven names (not always 'first'). Includes middle names
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namesfirst name, middle name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. RelatedPerson.name.prefix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

ShortParts that come before the name
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. RelatedPerson.name.suffix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

ShortParts that come after the name
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. RelatedPerson.name.period
Definition

Indicates the period of time when this name was valid for the named person.

ShortTime period when name was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows names to be placed in historical context.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
226. RelatedPerson.telecom
Definition

A contact detail for the person, e.g. a telephone number or an email address.

ShortA contact detail for the person
Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Control0..*
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
228. RelatedPerson.telecom.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
230. RelatedPerson.telecom.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.telecom.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
232. RelatedPerson.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Shortphone | fax | email | pager | url | sms | other
Control0..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystemVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/contact-point-system-vs|0.13.0)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. RelatedPerson.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

ShortThe actual contact point details
Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control0..1
This element is affected by the following invariants: cpt-2
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. RelatedPerson.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from TelecomUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/telecom-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. RelatedPerson.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

ShortSpecify preferred order of use (1 = highest)
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.

Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. RelatedPerson.telecom.period
Definition

Time period when the contact point was/is in use.

ShortTime period when the contact point was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. RelatedPerson.gender
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Shortmale | female | other | unknown
Control0..1
BindingThe codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)

The gender of a person used for administrative purposes.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. RelatedPerson.gender.id
Definition

unique id for the element within a resource (for internal references)

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
246. RelatedPerson.gender.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.gender.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
248. RelatedPerson.gender.extension:gender-other-2
Slice Namegender-other-2
Definition

Extension for more precise differentiation of the administrative gender 'other', aligned with German base profiles representation of the same concept.

ShortDifferentiation of the administrative gender 'other'
Control0..1
TypeExtension(Differentiation of the administrative gender 'other') (Extension Type: Coding)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
250. RelatedPerson.gender.value
Definition

Primitive value for code

ShortPrimitive value for code
Control0..1
Typecode
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
252. RelatedPerson.birthDate
Definition

The date on which the related person was born.

ShortThe date on which the related person was born
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. RelatedPerson.address
Definition

Address where the related person can be contacted or visited.

ShortAddress where the related person can be contacted or visited
Control0..*
TypeAddress
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on RelatedPerson.address. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ country

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

256. RelatedPerson.address:uzAddress
Slice NameuzAddress
Definition

Address where the related person can be contacted or visited.

ShortAn Uzbekistan address
Control0..*
TypeAddress
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. RelatedPerson.address:uzAddress.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
260. RelatedPerson.address:uzAddress.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.address.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
262. RelatedPerson.address:uzAddress.use
Definition

The purpose of this address.

ShortType of address, home | temp
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

ExampleGeneral: home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
264. RelatedPerson.address:uzAddress.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
BindingThe codes SHALL be taken from AddressTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-type-vs|0.13.0)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. RelatedPerson.address:uzAddress.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText part of the address provided by DPM. Mahalla name, street, house number, apartment number
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

ExampleGeneral: 137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. RelatedPerson.address:uzAddress.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortText street name provided by DPM
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. RelatedPerson.address:uzAddress.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortMahalla code (citizens' assembly)
Control0..1
BindingThe codes SHALL be taken from MahallaVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/mahalla-vs|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
ExampleGeneral: Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. RelatedPerson.address:uzAddress.district
Definition

The name of the administrative area (county).

ShortDistrict or city code
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
BindingThe codes SHALL be taken from RegionsVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/regions-vs|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesCounty
ExampleGeneral: Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. RelatedPerson.address:uzAddress.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortRegion code
Control0..1
BindingThe codes SHALL be taken from StateVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/state-vs|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. RelatedPerson.address:uzAddress.postalCode
Definition

A postal code designating a region defined by the postal service.

ShortPostal code for area
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
ExampleGeneral: 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. RelatedPerson.address:uzAddress.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry code (ISO 3166-1 2 letter code)
Comments

ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Pattern Value
{
  "country" : "UZ"
}
<country value="UZ"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
280. RelatedPerson.address:uzAddress.period
Definition

Time period when address was/is in use.

ShortTime period when the address was/is used
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows addresses to be placed in historical context.

ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. RelatedPerson.address:i18nAddress
Slice Namei18nAddress
Definition

Address where the related person can be contacted or visited.

ShortAn international, non-Uzbekistan address
Control0..*
TypeAddress
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
284. RelatedPerson.address:i18nAddress.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
286. RelatedPerson.address:i18nAddress.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RelatedPerson.address.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
288. RelatedPerson.address:i18nAddress.use
Definition

The purpose of this address.

ShortType of address, home | temp
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-use-vs|0.13.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

ExampleGeneral: home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
290. RelatedPerson.address:i18nAddress.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
BindingThe codes SHALL be taken from AddressTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/address-type-vs|0.13.0)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
292. RelatedPerson.address:i18nAddress.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText part of the address
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

ExampleGeneral: 137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. RelatedPerson.address:i18nAddress.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortStreet name or address line
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
296. RelatedPerson.address:i18nAddress.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortCity or locality
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
ExampleGeneral: Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
298. RelatedPerson.address:i18nAddress.district
Definition

The name of the administrative area (county).

ShortDistrict, county, or administrative division
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesCounty
ExampleGeneral: Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
300. RelatedPerson.address:i18nAddress.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortState, province, or region
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
302. RelatedPerson.address:i18nAddress.postalCode
Definition

A postal code designating a region defined by the postal service.

ShortPostal code for area
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
ExampleGeneral: 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. RelatedPerson.address:i18nAddress.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry code (ISO 3166-1 2 letter code)
Comments

ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

Control1..1
BindingThe codes SHALL be taken from ISO3166_2SansUZ (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/iso-3166-2-vs-sans-uz|0.13.0)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. RelatedPerson.address:i18nAddress.period
Definition

Time period when address was/is in use.

ShortTime period when the address was/is used
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows addresses to be placed in historical context.

ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
308. RelatedPerson.photo
Definition

Image of the person.

ShortImage of the person
Control0..*
TypeAttachment
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. RelatedPerson.period
Definition

The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

ShortPeriod of time that this relationship is considered valid
Comments

If an individual has a relationship with a patient over multiple, non-adjacent periods, there should be a distinct RelatedPerson instance for each period. For example, if a person is a roommate for a period of time, moves out, and is later a roommate with the same person again, you would have two RelatedPerson instances.

Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. RelatedPerson.communication
Definition

A language which may be used to communicate with the related person about the patient's health.

ShortA language which may be used to communicate with the related person about the patient's health
Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. RelatedPerson.communication.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
316. RelatedPerson.communication.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
318. RelatedPerson.communication.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
320. RelatedPerson.communication.language
Definition

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English.

ShortThe language which can be used to communicate with the related person about the patient's health
Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Control1..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
322. RelatedPerson.communication.preferred
Definition

Indicates whether or not the related person prefers this language (over other languages he or she masters up a certain level).

ShortLanguage preference indicator
Comments

This language is specifically identified for communicating healthcare information.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))