International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions
Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.10--20170302000000 | Version: 1.0 | |||
Draft as of 2017-03-02 | Computable Name: IPSResultObservation | |||
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.10 (use: OFFICIAL) |
This generic template is the basic set of constraints, which apply to any kind of observation grouped in a Result Organizer. The IPS Result Observation template is generic. It is further specialized by child templates, which constrain clinical laboratory observations or radiology observations or anatomic pathology observations. The generic IPS Result Observation template is usable in a patient summary for observations, which do not fall within one of the specialized categories. The result observation includes a statusCode to allow recording the status of an observation. “Pending” results (e.g., a test has been run but results have not been reported yet.html) should be represented as “active” ActStatus. However, in most cases, observations selected for an international patient summary are results that are final and approved, and thus, have a “completed” statusCode. The result of the observation may be commented through an entryRelationship introducing an “IPS Comment activity” template.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CDAR2.Observation | Base for all types and resources | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: OBS | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: EVN | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.10 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: IPS Results Observation (required): IPS Results Observation |
![]() ![]() ![]() | S | 1..1 | CS | |
![]() ![]() ![]() | S | 1..1 | IVL_TS | |
![]() ![]() ![]() | S | 0..1 | CE | Binding: ObservationInterpretation (required): ObservationInterpretation |
![]() ![]() ![]() | 0..1 | CD | Binding: IPS Target Site (preferred): IPS Target Site | |
![]() ![]() ![]() | S | 0..* | Author | |
![]() ![]() ![]() | 0..* | Element | Slice: Unordered, Open by value:profile | |
![]() ![]() ![]() ![]() | C | 0..* | IPSCommentActivity | Base for all types and resources entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() ![]() ![]() | S | 0..* | Element | |
![]() ![]() ![]() ![]() | S | 1..1 | ObservationRange | |
![]() ![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() ![]() | S | 1..1 | BL, ED, ED, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CE | ||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: N | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: 2.16.840.1.113883.5.83 | |
![]() |
Path | Conformance | ValueSet |
Observation.code | required | IPSResultsObservation (a valid code from LOINC) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.targetSiteCode | preferred | IPSTargetSiteCode |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) : |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CDAR2.Observation | Base for all types and resources | |
![]() ![]() ![]() | 1..1 | code | Binding: ActClassObservation (required) Fixed Value: OBS | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: EVN | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.10 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: IPS Results Observation (required): IPS Results Observation |
![]() ![]() ![]() | S | 1..1 | CS | Binding: ActStatus (required) |
![]() ![]() ![]() | S | 1..1 | IVL_TS | |
![]() ![]() ![]() | S | 0..1 | CE | Binding: ObservationInterpretation (required): ObservationInterpretation |
![]() ![]() ![]() | 0..1 | CD | Binding: IPS Target Site (preferred): IPS Target Site | |
![]() ![]() ![]() | S | 0..* | Author | |
![]() ![]() ![]() | C | 0..* | Element | Slice: Unordered, Open by value:profile |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() ![]() ![]() ![]() | C | 0..* | IPSCommentActivity | Base for all types and resources entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() ![]() ![]() | S | 0..* | Element | |
![]() ![]() ![]() ![]() | 1..1 | code | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
![]() ![]() ![]() ![]() | S | 1..1 | ObservationRange | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Binding: ActClassObservation (required) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Binding: ActMoodPredicate (required) Fixed Value: EVN.CRT | |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | ||
![]() ![]() ![]() ![]() ![]() ![]() | BL | |||
![]() ![]() ![]() ![]() ![]() ![]() | ED | |||
![]() ![]() ![]() ![]() ![]() ![]() | ED | |||
![]() ![]() ![]() ![]() ![]() ![]() | CD | |||
![]() ![]() ![]() ![]() ![]() ![]() | CV | |||
![]() ![]() ![]() ![]() ![]() ![]() | CE | |||
![]() ![]() ![]() ![]() ![]() ![]() | SC | |||
![]() ![]() ![]() ![]() ![]() ![]() | II | |||
![]() ![]() ![]() ![]() ![]() ![]() | TEL | |||
![]() ![]() ![]() ![]() ![]() ![]() | AD | |||
![]() ![]() ![]() ![]() ![]() ![]() | EN | |||
![]() ![]() ![]() ![]() ![]() ![]() | INT | |||
![]() ![]() ![]() ![]() ![]() ![]() | REAL | |||
![]() ![]() ![]() ![]() ![]() ![]() | PQ | |||
![]() ![]() ![]() ![]() ![]() ![]() | MO | |||
![]() ![]() ![]() ![]() ![]() ![]() | TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | IVL_PQ | |||
![]() ![]() ![]() ![]() ![]() ![]() | IVL_TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | PIVL_TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | EIVL_TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | SXPR_TS | |||
![]() ![]() ![]() ![]() ![]() | 0..1 | CE | Binding: ObservationInterpretation (required) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: N | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: 2.16.840.1.113883.5.83 | |
![]() |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.code | required | IPSResultsObservation (a valid code from LOINC) |
Observation.statusCode | required | ActStatus |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.targetSiteCode | preferred | IPSTargetSiteCode |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Observation.referenceRange.observationRange.classCode | required | ActClassObservation |
Observation.referenceRange.observationRange.moodCode | required | Fixed Value: EVN.CRT |
Observation.referenceRange.observationRange.interpretationCode | required | ObservationInterpretation |
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()) | |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) : | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.templateId:primary.nullFlavor | required | NullFlavor |
Observation.code | required | IPSResultsObservation (a valid code from LOINC) |
Observation.statusCode | required | ActStatus |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.targetSiteCode | preferred | IPSTargetSiteCode |
Observation.subject.typeCode | required | Fixed Value: SBJ |
Observation.subject.contextControlCode | required | Fixed Value: OP |
Observation.subject.awarenessCode | extensible | TargetAwareness |
Observation.informant.typeCode | required | Fixed Value: INF |
Observation.informant.contextControlCode | required | Fixed Value: OP |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Observation.referenceRange.observationRange.classCode | required | ActClassObservation |
Observation.referenceRange.observationRange.moodCode | required | Fixed Value: EVN.CRT |
Observation.referenceRange.observationRange.interpretationCode | required | ObservationInterpretation |
Observation.referenceRange.observationRange.interpretationCode.nullFlavor | required | NullFlavor |
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()) | |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) : | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 7 elements (3 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 6 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CDAR2.Observation | Base for all types and resources | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: OBS | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: EVN | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.10 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: IPS Results Observation (required): IPS Results Observation |
![]() ![]() ![]() | S | 1..1 | CS | |
![]() ![]() ![]() | S | 1..1 | IVL_TS | |
![]() ![]() ![]() | S | 0..1 | CE | Binding: ObservationInterpretation (required): ObservationInterpretation |
![]() ![]() ![]() | 0..1 | CD | Binding: IPS Target Site (preferred): IPS Target Site | |
![]() ![]() ![]() | S | 0..* | Author | |
![]() ![]() ![]() | 0..* | Element | Slice: Unordered, Open by value:profile | |
![]() ![]() ![]() ![]() | C | 0..* | IPSCommentActivity | Base for all types and resources entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() ![]() ![]() | S | 0..* | Element | |
![]() ![]() ![]() ![]() | S | 1..1 | ObservationRange | |
![]() ![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() ![]() | S | 1..1 | BL, ED, ED, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CE | ||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: N | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: 2.16.840.1.113883.5.83 | |
![]() |
Path | Conformance | ValueSet |
Observation.code | required | IPSResultsObservation (a valid code from LOINC) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.targetSiteCode | preferred | IPSTargetSiteCode |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CDAR2.Observation | Base for all types and resources | |
![]() ![]() ![]() | 1..1 | code | Binding: ActClassObservation (required) Fixed Value: OBS | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: EVN | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.10 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: IPS Results Observation (required): IPS Results Observation |
![]() ![]() ![]() | S | 1..1 | CS | Binding: ActStatus (required) |
![]() ![]() ![]() | S | 1..1 | IVL_TS | |
![]() ![]() ![]() | S | 0..1 | CE | Binding: ObservationInterpretation (required): ObservationInterpretation |
![]() ![]() ![]() | 0..1 | CD | Binding: IPS Target Site (preferred): IPS Target Site | |
![]() ![]() ![]() | S | 0..* | Author | |
![]() ![]() ![]() | C | 0..* | Element | Slice: Unordered, Open by value:profile |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() ![]() ![]() ![]() | C | 0..* | IPSCommentActivity | Base for all types and resources entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() ![]() ![]() | S | 0..* | Element | |
![]() ![]() ![]() ![]() | 1..1 | code | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
![]() ![]() ![]() ![]() | S | 1..1 | ObservationRange | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Binding: ActClassObservation (required) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Binding: ActMoodPredicate (required) Fixed Value: EVN.CRT | |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | ||
![]() ![]() ![]() ![]() ![]() ![]() | BL | |||
![]() ![]() ![]() ![]() ![]() ![]() | ED | |||
![]() ![]() ![]() ![]() ![]() ![]() | ED | |||
![]() ![]() ![]() ![]() ![]() ![]() | CD | |||
![]() ![]() ![]() ![]() ![]() ![]() | CV | |||
![]() ![]() ![]() ![]() ![]() ![]() | CE | |||
![]() ![]() ![]() ![]() ![]() ![]() | SC | |||
![]() ![]() ![]() ![]() ![]() ![]() | II | |||
![]() ![]() ![]() ![]() ![]() ![]() | TEL | |||
![]() ![]() ![]() ![]() ![]() ![]() | AD | |||
![]() ![]() ![]() ![]() ![]() ![]() | EN | |||
![]() ![]() ![]() ![]() ![]() ![]() | INT | |||
![]() ![]() ![]() ![]() ![]() ![]() | REAL | |||
![]() ![]() ![]() ![]() ![]() ![]() | PQ | |||
![]() ![]() ![]() ![]() ![]() ![]() | MO | |||
![]() ![]() ![]() ![]() ![]() ![]() | TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | IVL_PQ | |||
![]() ![]() ![]() ![]() ![]() ![]() | IVL_TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | PIVL_TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | EIVL_TS | |||
![]() ![]() ![]() ![]() ![]() ![]() | SXPR_TS | |||
![]() ![]() ![]() ![]() ![]() | 0..1 | CE | Binding: ObservationInterpretation (required) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: N | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Fixed Value: 2.16.840.1.113883.5.83 | |
![]() |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.code | required | IPSResultsObservation (a valid code from LOINC) |
Observation.statusCode | required | ActStatus |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.targetSiteCode | preferred | IPSTargetSiteCode |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Observation.referenceRange.observationRange.classCode | required | ActClassObservation |
Observation.referenceRange.observationRange.moodCode | required | Fixed Value: EVN.CRT |
Observation.referenceRange.observationRange.interpretationCode | required | ObservationInterpretation |
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()) | |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) : | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Snapshot View
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Fixed Value: OBS |
Observation.templateId:primary.nullFlavor | required | NullFlavor |
Observation.code | required | IPSResultsObservation (a valid code from LOINC) |
Observation.statusCode | required | ActStatus |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.targetSiteCode | preferred | IPSTargetSiteCode |
Observation.subject.typeCode | required | Fixed Value: SBJ |
Observation.subject.contextControlCode | required | Fixed Value: OP |
Observation.subject.awarenessCode | extensible | TargetAwareness |
Observation.informant.typeCode | required | Fixed Value: INF |
Observation.informant.contextControlCode | required | Fixed Value: OP |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Observation.referenceRange.observationRange.classCode | required | ActClassObservation |
Observation.referenceRange.observationRange.moodCode | required | Fixed Value: EVN.CRT |
Observation.referenceRange.observationRange.interpretationCode | required | ObservationInterpretation |
Observation.referenceRange.observationRange.interpretationCode.nullFlavor | required | NullFlavor |
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()) | |
entryRelationship-1 | null | Observation.entryRelationship:entryRelationship-1 | contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05.html) : | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 7 elements (3 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 6 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron