International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
This page is part of the International Patient Summary Implementation Guide (v2.0.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Practitioner-uv-ips | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: PractitionerUvIps | ||
This profile constrains the practitioner resource to represent a practitioner acting as observer for these imaging results.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
  name |
SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||||
 use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||
| family |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
 given |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
| ||||||||
| address |
SOΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
Practitioner | |||||||||||
 name |
SO | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||||
| family |
SO | 0..1 | string | Family name (often called 'Surname')
| ||||||||
| given |
SO | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||||
| telecom |
SO | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
| ||||||||
| address |
SO | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent | ||||||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||||||
| name |
SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||||||
| family |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
| given |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
| ||||||||
| address |
SOΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
| ||||||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||||||
 issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | example | v2 table 0360, Version 2.7 | 📦0360 | FHIR Std. |
| Practitioner.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Practitioner
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| name |
SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||
| family |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
| given |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
| ||||||||
| address |
SOΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
Practitioner | |||||||||||
| name |
SO | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||||
| family |
SO | 0..1 | string | Family name (often called 'Surname')
| ||||||||
| given |
SO | 0..* | string | Given names (not always 'first'). Includes middle names
| ||||||||
| telecom |
SO | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
| ||||||||
| address |
SO | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
| ||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | An identifier for the person as this agent | ||||||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||||||
| name |
SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||||||
| family |
SOΣ | 0..1 | string | Family name (often called 'Surname')
| ||||||||
| given |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
| ||||||||
| address |
SOΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
| ||||||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | example | v2 table 0360, Version 2.7 | 📦0360 | FHIR Std. |
| Practitioner.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Practitioner
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2025-10-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change