International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Organization-uv-ips | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: OrganizationUvIps | ||
This profile constrains the Organization resource to represent an organization that acts as performer or observer for a result observation (laboratory, pathology or imaging), or as performer for a procedure.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use ele-1: All FHIR elements must have a @value or children | ||||||||
| name |
SOΣC | 1..1 | string | Name used for the organization ele-1: All FHIR elements must have a @value or children
| ||||||||
 telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization ele-1: All FHIR elements must have a @value or children org-3: The telecom of an organization can never be of use 'home'
| ||||||||
 address |
SOC | 0..* | Address | An address for the organization ele-1: All FHIR elements must have a @value or children org-2: An address of an organization can never be of use 'home'
| ||||||||
| Documentation for this format | ||||||||||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
Organization | |||||||||||
 name |
SO | 1..1 | string | Name used for the organization
| ||||||||
| telecom |
SO | 0..* | ContactPoint | A contact detail for the organization
| ||||||||
| address |
SO | 0..* | Address | An address for the organization
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||||||
| 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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems | ||||||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||||||
| type |
Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||||||
| name |
SOΣC | 1..1 | string | Name used for the organization
| ||||||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
| ||||||||
| address |
SOC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home'
| ||||||||
 partOf |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||||||
 contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||||||
 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 | ||||||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||||||
| name |
0..1 | HumanName | A name associated with the contact | |||||||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from Organization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use ele-1: All FHIR elements must have a @value or children | ||||||||
| name |
SOΣC | 1..1 | string | Name used for the organization ele-1: All FHIR elements must have a @value or children
| ||||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization ele-1: All FHIR elements must have a @value or children org-3: The telecom of an organization can never be of use 'home'
| ||||||||
| address |
SOC | 0..* | Address | An address for the organization ele-1: All FHIR elements must have a @value or children org-2: An address of an organization can never be of use 'home'
| ||||||||
| Documentation for this format | ||||||||||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
Organization | |||||||||||
| name |
SO | 1..1 | string | Name used for the organization
| ||||||||
| telecom |
SO | 0..* | ContactPoint | A contact detail for the organization
| ||||||||
| address |
SO | 0..* | Address | An address for the organization
| ||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||||||
| 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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems | ||||||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||||||
| type |
Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||||||
| name |
SOΣC | 1..1 | string | Name used for the organization
| ||||||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||||||
| telecom |
SOC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
| ||||||||
| address |
SOC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home'
| ||||||||
| partOf |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||||||
| 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 | ||||||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||||||
| name |
0..1 | HumanName | A name associated with the contact | |||||||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from Organization
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-04-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change