International Patient Summary Implementation Guide
1.0.0 - STU 1
International Patient Summary Implementation Guide
1.0.0 - STU 1
This page is part of the International Patient Summary Implementation Guide (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
This profile constrains the Media resource (which is a specialized observation).
The official URL for this profile is:
http://hl7.org/fhir/uv/ips/StructureDefinition/Media-observation-uv-ips
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Media
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Media | S | 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 | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: completed |
 type | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text |
  subject | S | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of |
  reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| operator | S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| device | S | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| content | S | 1..1 | Attachment | Actual Media - reference or data |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | SI | 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 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Identifier(s) for the image |
| basedOn | ΣI | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created |
| partOf | ΣI | 0..* | Reference(Resource) | Part of referenced event |
| status | ?!SΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) Fixed Value: completed |
| type | SI | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible) |
| modality | ΣI | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example) |
| view | ΣI | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example) |
| subject | SΣI | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| encounter | ΣI | 0..1 | Reference(Encounter) | Encounter associated with media |
 created[x] | ΣI | 0..1 | When Media was collected | |
| createdDateTime | dateTime | |||
| createdPeriod | Period | |||
| issued | ΣI | 0..1 | instant | Date/Time this version was made available |
| operator | SΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| reasonCode | ΣI | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example) |
| bodySite | ΣI | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example) |
| deviceName | ΣI | 0..1 | string | Name of the device/manufacturer |
| device | SΣI | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| height | ΣI | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | ΣI | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | ΣI | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | ΣI | 0..1 | decimal | Length in seconds (audio / video) |
| content | SΣI | 1..1 | Attachment | Actual Media - reference or data |
| note | I | 0..* | Annotation | Comments made about the media |
| Documentation for this format | ||||
This structure is derived from Media
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | S | 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 | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Fixed Value: completed |
| type | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text |
| subject | S | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| operator | S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| device | S | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| content | S | 1..1 | Attachment | Actual Media - reference or data |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | SI | 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 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Identifier(s) for the image |
| basedOn | ΣI | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created |
| partOf | ΣI | 0..* | Reference(Resource) | Part of referenced event |
| status | ?!SΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) Fixed Value: completed |
| type | SI | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible) |
| modality | ΣI | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example) |
| view | ΣI | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example) |
| subject | SΣI | 1..1 | Reference(Patient (IPS)) | Who/What this Media is a record of |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| encounter | ΣI | 0..1 | Reference(Encounter) | Encounter associated with media |
| created[x] | ΣI | 0..1 | When Media was collected | |
| createdDateTime | dateTime | |||
| createdPeriod | Period | |||
| issued | ΣI | 0..1 | instant | Date/Time this version was made available |
| operator | SΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| reasonCode | ΣI | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example) |
| bodySite | ΣI | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example) |
| deviceName | ΣI | 0..1 | string | Name of the device/manufacturer |
| device | SΣI | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| height | ΣI | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | ΣI | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | ΣI | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | ΣI | 0..1 | decimal | Length in seconds (audio / video) |
| content | SΣI | 1..1 | Attachment | Actual Media - reference or data |
| note | I | 0..* | Annotation | Comments made about the media |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet / Code |
| Media.language | preferred | CommonLanguages Max Binding: AllLanguages |
| 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 | Path | Details | Requirements |
| dom-2 | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Media | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Media.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Media.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Media.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Media.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Media.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.modality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.view | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.subject.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Media.subject.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Media.subject.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.subject.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.subject.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.subject.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.created[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.issued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.operator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.deviceName | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.device | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.height | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.width | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.frames | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.duration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ Health Level Seven International - Patient Care Work Group. Package hl7.fhir.uv.ips#1.0.0 based on FHIR 4.0.1. Generated 2020-05-19
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change