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/costateixeira/fhir-ips/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/CrossOrganizationFeature | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: CrossOrganizationFeature | ||
Cross organization communication including cross-border and cross-boundary scenarios
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CrossOrganizationFeature |
0..* | Base | Cross Organization Instances of this logical model can be the target of a Reference | |
  originatingOrganization |
0..1 | Reference() | Originating organization (affiliation) | |
 organizationCodes |
0..* | CodeableConcept | Organization codes | |
| specificRequirements |
0..1 | CodeableConcept | Organization specific requirements | |
| asserter |
0..1 | CodeableConcept | Asserter (source of information) | |
 dateOfDocumentCreation |
0..1 | dateTime | Date of IPS document creation | |
| languageOfDocument |
0..1 | CodeableConcept | Language of document | |
| dateOfLastUpdate |
0..1 | dateTime | Date of last update of IPS content | |
 generationOfContent |
0..1 | CodeableConcept | Generation of IPS content ele-1: All FHIR elements must have a @value or children | |
 @id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
 natureOfIPS |
0..1 | CodeableConcept | Nature of the IPS | |
| healthcareProviders |
C | 0..* | Reference() | Healthcare providers ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| authoringHealthcareProvider |
0..1 | Reference() | Authoring healthcare provider | |
 legitimacy |
0..1 | BackboneElement | Legitimacy ele-1: All FHIR elements must have a @value or children | |
 @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| legalAuthenticator |
0..1 | Reference() | Legal authenticator | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CrossOrganizationFeature.healthcareProviders.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ref-1 | error | CrossOrganizationFeature.healthcareProviders | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CrossOrganizationFeature |
0..* | Base | Cross Organization Instances of this logical model can be the target of a Reference | |
| originatingOrganization |
0..1 | Reference() | Originating organization (affiliation) | |
| organizationCodes |
0..* | CodeableConcept | Organization codes | |
| specificRequirements |
0..1 | CodeableConcept | Organization specific requirements | |
| asserter |
0..1 | CodeableConcept | Asserter (source of information) | |
| dateOfDocumentCreation |
0..1 | dateTime | Date of IPS document creation | |
| languageOfDocument |
0..1 | CodeableConcept | Language of document | |
| dateOfLastUpdate |
0..1 | dateTime | Date of last update of IPS content | |
| generationOfContent |
0..1 | CodeableConcept | Generation of IPS content | |
| natureOfIPS |
0..1 | CodeableConcept | Nature of the IPS | |
| healthcareProviders |
0..* | Reference() | Healthcare providers | |
| authoringHealthcareProvider |
0..1 | Reference() | Authoring healthcare provider | |
| legitimacy |
0..1 | BackboneElement | Legitimacy | |
| legalAuthenticator |
0..1 | Reference() | Legal authenticator | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CrossOrganizationFeature |
0..* | Base | Cross Organization Instances of this logical model can be the target of a Reference | |
| originatingOrganization |
0..1 | Reference() | Originating organization (affiliation) | |
| organizationCodes |
0..* | CodeableConcept | Organization codes | |
| specificRequirements |
0..1 | CodeableConcept | Organization specific requirements | |
| asserter |
0..1 | CodeableConcept | Asserter (source of information) | |
| dateOfDocumentCreation |
0..1 | dateTime | Date of IPS document creation | |
| languageOfDocument |
0..1 | CodeableConcept | Language of document | |
| dateOfLastUpdate |
0..1 | dateTime | Date of last update of IPS content | |
| generationOfContent |
0..1 | CodeableConcept | Generation of IPS content | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| natureOfIPS |
0..1 | CodeableConcept | Nature of the IPS | |
| healthcareProviders |
C | 0..* | Reference() | Healthcare providers ref-1: SHALL have a contained resource if a local reference is provided |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| authoringHealthcareProvider |
0..1 | Reference() | Authoring healthcare provider | |
| legitimacy |
0..1 | BackboneElement | Legitimacy | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| legalAuthenticator |
0..1 | Reference() | Legal authenticator | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CrossOrganizationFeature.healthcareProviders.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ref-1 | error | CrossOrganizationFeature.healthcareProviders | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CrossOrganizationFeature |
0..* | Base | Cross Organization Instances of this logical model can be the target of a Reference | |
| originatingOrganization |
0..1 | Reference() | Originating organization (affiliation) | |
| organizationCodes |
0..* | CodeableConcept | Organization codes | |
| specificRequirements |
0..1 | CodeableConcept | Organization specific requirements | |
| asserter |
0..1 | CodeableConcept | Asserter (source of information) | |
| dateOfDocumentCreation |
0..1 | dateTime | Date of IPS document creation | |
| languageOfDocument |
0..1 | CodeableConcept | Language of document | |
| dateOfLastUpdate |
0..1 | dateTime | Date of last update of IPS content | |
| generationOfContent |
0..1 | CodeableConcept | Generation of IPS content ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| natureOfIPS |
0..1 | CodeableConcept | Nature of the IPS | |
| healthcareProviders |
C | 0..* | Reference() | Healthcare providers ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| authoringHealthcareProvider |
0..1 | Reference() | Authoring healthcare provider | |
| legitimacy |
0..1 | BackboneElement | Legitimacy ele-1: All FHIR elements must have a @value or children | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| legalAuthenticator |
0..1 | Reference() | Legal authenticator | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CrossOrganizationFeature.healthcareProviders.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ref-1 | error | CrossOrganizationFeature.healthcareProviders | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CrossOrganizationFeature |
0..* | Base | Cross Organization Instances of this logical model can be the target of a Reference | |
| originatingOrganization |
0..1 | Reference() | Originating organization (affiliation) | |
| organizationCodes |
0..* | CodeableConcept | Organization codes | |
| specificRequirements |
0..1 | CodeableConcept | Organization specific requirements | |
| asserter |
0..1 | CodeableConcept | Asserter (source of information) | |
| dateOfDocumentCreation |
0..1 | dateTime | Date of IPS document creation | |
| languageOfDocument |
0..1 | CodeableConcept | Language of document | |
| dateOfLastUpdate |
0..1 | dateTime | Date of last update of IPS content | |
| generationOfContent |
0..1 | CodeableConcept | Generation of IPS content | |
| natureOfIPS |
0..1 | CodeableConcept | Nature of the IPS | |
| healthcareProviders |
0..* | Reference() | Healthcare providers | |
| authoringHealthcareProvider |
0..1 | Reference() | Authoring healthcare provider | |
| legitimacy |
0..1 | BackboneElement | Legitimacy | |
| legalAuthenticator |
0..1 | Reference() | Legal authenticator | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CrossOrganizationFeature |
0..* | Base | Cross Organization Instances of this logical model can be the target of a Reference | |
| originatingOrganization |
0..1 | Reference() | Originating organization (affiliation) | |
| organizationCodes |
0..* | CodeableConcept | Organization codes | |
| specificRequirements |
0..1 | CodeableConcept | Organization specific requirements | |
| asserter |
0..1 | CodeableConcept | Asserter (source of information) | |
| dateOfDocumentCreation |
0..1 | dateTime | Date of IPS document creation | |
| languageOfDocument |
0..1 | CodeableConcept | Language of document | |
| dateOfLastUpdate |
0..1 | dateTime | Date of last update of IPS content | |
| generationOfContent |
0..1 | CodeableConcept | Generation of IPS content | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| natureOfIPS |
0..1 | CodeableConcept | Nature of the IPS | |
| healthcareProviders |
C | 0..* | Reference() | Healthcare providers ref-1: SHALL have a contained resource if a local reference is provided |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| authoringHealthcareProvider |
0..1 | Reference() | Authoring healthcare provider | |
| legitimacy |
0..1 | BackboneElement | Legitimacy | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| legalAuthenticator |
0..1 | Reference() | Legal authenticator | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CrossOrganizationFeature.healthcareProviders.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ref-1 | error | CrossOrganizationFeature.healthcareProviders | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2024-12-29
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change