This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
SD.10 StructureDefinition-imagingstudy-uv-ips
This profile represents the contraints applied to the ImagingStudy resource by the IPS project, which specifies the information on a DICOM imaging study this imaging result is part of.
Conformance resource variables defined here
SD.10.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/imagingstudy-uv-ips
Published on Tue Feb 20 23:22:59 AEDT 2018 as a draft by .
This profile builds on ImagingStudy
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImagingStudy | I | 0..* | A set of images produced in single study (one or more series of references images) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
  id | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
 meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) ele-1: All FHIR elements must have a @value or children |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
 contained | 0..* | Resource | Contained, inline Resources | |
| uid | SΣI | 1..1 | oid | Formal DICOM identifier for the study ele-1: All FHIR elements must have a @value or children Example General': urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045 |
| accession | ΣI | 0..1 | Identifier | Related workflow identifier ("Accession Number") ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
 userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General': http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General': 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
 assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..* | Identifier | Other identifiers for the study ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General': http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General': 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| availability | ΣI | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE Binding: InstanceAvailability (required) ele-1: All FHIR elements must have a @value or children |
| modalityList | ΣI | 0..* | Coding | All series modality if actual acquisition modalities Binding: Acquisition Modality Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| patient | SΣI | 1..1 | Reference(Patient-uv-ips) | Who the images are of 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| context | ΣI | 0..1 | Reference(Encounter | EpisodeOfCare) | Originating context 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| started | SΣI | 0..1 | dateTime | When the study was started ele-1: All FHIR elements must have a @value or children Example General': 2011-01-01T11:01:20+03:00 |
| basedOn | ΣI | 0..* | Reference(ReferralRequest | CarePlan | ProcedureRequest) | Request fulfilled 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| referrer | ΣI | 0..1 | Reference(Practitioner) | Referring physician 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| interpreter | ΣI | 0..* | Reference(Practitioner) | Who interpreted images 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| endpoint | ΣI | 0..* | Reference(Endpoint) | Study access endpoint 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| numberOfSeries | ΣI | 0..1 | unsignedInt | Number of Study Related Series ele-1: All FHIR elements must have a @value or children |
| numberOfInstances | ΣI | 0..1 | unsignedInt | Number of Study Related Instances ele-1: All FHIR elements must have a @value or children |
| procedureReference | ΣI | 0..* | Reference(Procedure) | The performed Procedure reference 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| procedureCode | SΣI | 0..* | CodeableConcept-uv-ips | The performed procedure code Binding: Procedure Codes (SNOMED CT) (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| reason | SΣI | 0..1 | CodeableConcept | Why the study was requested Binding: Procedure Reason Codes (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | SΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| description | ΣI | 0..1 | string | Institution-generated description ele-1: All FHIR elements must have a @value or children |
| series | SΣI | 0..* | BackboneElement | Each study has one or more series of instances ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 modifierExtension | ?!ΣI | 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 |
| uid | SΣI | 1..1 | oid | Formal DICOM identifier for this series ele-1: All FHIR elements must have a @value or children Example General': urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
| number | ΣI | 0..1 | unsignedInt | Numeric identifier of this series ele-1: All FHIR elements must have a @value or children Example General': 3 |
| modality | SΣI | 1..1 | Coding | The modality of the instances in the series Binding: Acquisition Modality Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| description | ΣI | 0..1 | string | A short human readable summary of the series ele-1: All FHIR elements must have a @value or children Example General': CT Surview 180 |
| numberOfInstances | ΣI | 0..1 | unsignedInt | Number of Series Related Instances ele-1: All FHIR elements must have a @value or children |
| availability | ΣI | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE Binding: InstanceAvailability (required) ele-1: All FHIR elements must have a @value or children |
| endpoint | ΣI | 0..* | Reference(Endpoint) | Series access endpoint 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| bodySite | ΣI | 0..1 | Coding | Body part examined Binding: SNOMED CT Body Structures (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| laterality | ΣI | 0..1 | Coding | Body part laterality Binding: Laterality (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| started | ΣI | 0..1 | dateTime | When the series started ele-1: All FHIR elements must have a @value or children |
| performer | ΣI | 0..* | Reference(Practitioner) | Who performed the series 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 | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| instance | SI | 0..* | BackboneElement | A single SOP instance from the series ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?!ΣI | 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 |
| uid | SI | 1..1 | oid | Formal DICOM identifier for this instance ele-1: All FHIR elements must have a @value or children Example General': urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903 |
| number | I | 0..1 | unsignedInt | The number of this instance in the series ele-1: All FHIR elements must have a @value or children Example General': 1 |
| sopClass | I | 1..1 | oid | DICOM class type ele-1: All FHIR elements must have a @value or children Example General': urn:oid:1.2.840.10008.5.1.4.1.1.2 |
| title | I | 0..1 | string | Description of instance ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
