International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1
International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1
This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Media-observation-uv-ips | Version: 1.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: MediaObservationUvIps | ||
This profile constrains the Media resource (which is a specialized observation).
This specialized observation is used to convey illustrative media content.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
  status | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: completed | |
 type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
  subject | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of | |
  reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| operator | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | |
| device | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | |
| content | 1..1 | Attachment | Actual Media - reference or data | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Fixed Value: completed |
| type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible): Codes for high level media categories. | |
| subject | Σ | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| content | Σ | 1..1 | Attachment | Actual Media - reference or data |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Media.status | required | Fixed Value: completed |
| Media.type | extensible | MediaType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Media | 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 | Media | 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 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Media | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
| 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 | Σ | 0..* | Identifier | Identifier(s) for the image | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Fixed Value: completed | ||||
| type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible): Codes for high level media categories. | |||||
| modality | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | ||||
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
| subject | Σ | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of | ||||
| 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 | 1..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 | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
 created[x] | Σ | 0..1 | When Media was collected | |||||
| createdDateTime | dateTime | |||||||
| createdPeriod | Period | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
| bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer | ||||
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
| height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
| width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
| frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
| duration | Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
| content | Σ | 1..1 | Attachment | Actual Media - reference or data | ||||
| note | 0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Media.language | preferred | CommonLanguages
| ||||
| Media.status | required | Fixed Value: completed | ||||
| Media.type | extensible | MediaType | ||||
| Media.modality | example | MediaModality | ||||
| Media.view | example | MediaCollectionView/Projection | ||||
| Media.subject.type | extensible | ResourceType | ||||
| Media.reasonCode | example | ProcedureReasonCodes | ||||
| Media.bodySite | example | SNOMEDCTBodyStructures |
| 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() |
This structure is derived from Media
Summary
Mandatory: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| status | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: completed | |
| type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
| subject | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of | |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| operator | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | |
| device | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | |
| content | 1..1 | Attachment | Actual Media - reference or data | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Fixed Value: completed |
| type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible): Codes for high level media categories. | |
| subject | Σ | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| content | Σ | 1..1 | Attachment | Actual Media - reference or data |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Media.status | required | Fixed Value: completed |
| Media.type | extensible | MediaType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Media | 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 | Media | 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 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Media | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
| 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 | Σ | 0..* | Identifier | Identifier(s) for the image | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Fixed Value: completed | ||||
| type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible): Codes for high level media categories. | |||||
| modality | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | ||||
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
| subject | Σ | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of | ||||
| 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 | 1..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 | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
| created[x] | Σ | 0..1 | When Media was collected | |||||
| createdDateTime | dateTime | |||||||
| createdPeriod | Period | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
| bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer | ||||
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
| height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
| width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
| frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
| duration | Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
| content | Σ | 1..1 | Attachment | Actual Media - reference or data | ||||
| note | 0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Media.language | preferred | CommonLanguages
| ||||
| Media.status | required | Fixed Value: completed | ||||
| Media.type | extensible | MediaType | ||||
| Media.modality | example | MediaModality | ||||
| Media.view | example | MediaCollectionView/Projection | ||||
| Media.subject.type | extensible | ResourceType | ||||
| Media.reasonCode | example | ProcedureReasonCodes | ||||
| Media.bodySite | example | SNOMEDCTBodyStructures |
| 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() |
This structure is derived from Media
Summary
Mandatory: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ Health Level Seven International - Patient Care Work Group. Package hl7.fhir.uv.ips#1.1.0 based on FHIR 4.0.1. Generated 2022-11-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change