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

StructureDefinition: ImagingStudyUvIps

This profile represents the constraints applied to the ImagingStudy resource by the IPS project, which specifies the information on a DICOM imaging study this imaging result is part of.

The official URL for this profile is: 

http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ImagingStudy

Summary

Mandatory: 1 element
Must-Support: 12 elements

Structures

This structure refers to these other structures:

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy S0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... identifier S0..*IdentifierIdentifiers for the whole study
... subject S1..1Reference(Patient (IPS))Who or what is the subject of the study
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... started S0..1dateTimeWhen the study was started
... reasonCode S0..*CodeableConceptIPSConcept - reference to a terminology or just text
... series S0..*BackboneElementEach study has one or more series of instances
.... uid S1..1idDICOM Series Instance UID for the series
.... modality S1..1CodingThe modality of the instances in the series
.... instance S0..*BackboneElementA single SOP instance from the series
..... uid S1..1idDICOM SOP Instance UID
..... sopClass S1..1CodingDICOM class type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy SI0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifiers for the whole study
... status ?!ΣI1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required)
... modality ΣI0..*CodingAll series modality if actual acquisition modalities
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
... subject SΣI1..1Reference(Patient (IPS))Who or what is the subject of the study
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... encounter ΣI0..1Reference(Encounter)Encounter with which this imaging study is associated
... started SΣI0..1dateTimeWhen the study was started
Example General: 2011-01-01T08:01:20+00:00
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)Request fulfilled
... referrer ΣI0..1Reference(Practitioner | PractitionerRole)Referring physician
... interpreter ΣI0..*Reference(Practitioner | PractitionerRole)Who interpreted images
... endpoint ΣI0..*Reference(Endpoint)Study access endpoint
... numberOfSeries ΣI0..1unsignedIntNumber of Study Related Series
... numberOfInstances ΣI0..1unsignedIntNumber of Study Related Instances
... procedureReference ΣI0..1Reference(Procedure)The performed Procedure reference
... procedureCode SI0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible)
... location ΣI0..1Reference(Location)Where ImagingStudy occurred
... reasonCode SI0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: ProcedureReasonCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)Why was study performed
... note ΣI0..*AnnotationUser-defined comments
... description ΣI0..1stringInstitution-generated description
... series SΣI0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uid SΣI1..1idDICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number ΣI0..1unsignedIntNumeric identifier of this series
Example General: 3
.... modality SΣI1..1CodingThe modality of the instances in the series
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
.... description ΣI0..1stringA short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances ΣI0..1unsignedIntNumber of Series Related Instances
.... endpoint ΣI0..*Reference(Endpoint)Series access endpoint
.... bodySite ΣI0..1CodingBody part examined
Binding: SNOMEDCTBodyStructures (example)
.... laterality ΣI0..1CodingBody part laterality
Binding: Laterality (example)
.... specimen ΣI0..*Reference(Specimen)Specimen imaged
.... started ΣI0..1dateTimeWhen the series started
.... performer ΣI0..*BackboneElementWho performed the series
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI0..1CodeableConceptType of performance
Binding: ImagingStudySeriesPerformerFunction (extensible)
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Who performed the series
.... instance SI0..*BackboneElementA single SOP instance from the series
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uid SI1..1idDICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass SI1..1CodingDICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number I0..1unsignedIntThe number of this instance in the series
Example General: 1
..... title I0..1stringDescription of instance

doco Documentation for this format

This structure is derived from ImagingStudy

Summary

Mandatory: 1 element
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy S0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... identifier S0..*IdentifierIdentifiers for the whole study
... subject S1..1Reference(Patient (IPS))Who or what is the subject of the study
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... started S0..1dateTimeWhen the study was started
... reasonCode S0..*CodeableConceptIPSConcept - reference to a terminology or just text
... series S0..*BackboneElementEach study has one or more series of instances
.... uid S1..1idDICOM Series Instance UID for the series
.... modality S1..1CodingThe modality of the instances in the series
.... instance S0..*BackboneElementA single SOP instance from the series
..... uid S1..1idDICOM SOP Instance UID
..... sopClass S1..1CodingDICOM class type

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy SI0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifiers for the whole study
... status ?!ΣI1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required)
... modality ΣI0..*CodingAll series modality if actual acquisition modalities
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
... subject SΣI1..1Reference(Patient (IPS))Who or what is the subject of the study
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... encounter ΣI0..1Reference(Encounter)Encounter with which this imaging study is associated
... started SΣI0..1dateTimeWhen the study was started
Example General: 2011-01-01T08:01:20+00:00
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)Request fulfilled
... referrer ΣI0..1Reference(Practitioner | PractitionerRole)Referring physician
... interpreter ΣI0..*Reference(Practitioner | PractitionerRole)Who interpreted images
... endpoint ΣI0..*Reference(Endpoint)Study access endpoint
... numberOfSeries ΣI0..1unsignedIntNumber of Study Related Series
... numberOfInstances ΣI0..1unsignedIntNumber of Study Related Instances
... procedureReference ΣI0..1Reference(Procedure)The performed Procedure reference
... procedureCode SI0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible)
... location ΣI0..1Reference(Location)Where ImagingStudy occurred
... reasonCode SI0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: ProcedureReasonCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)Why was study performed
... note ΣI0..*AnnotationUser-defined comments
... description ΣI0..1stringInstitution-generated description
... series SΣI0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uid SΣI1..1idDICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number ΣI0..1unsignedIntNumeric identifier of this series
Example General: 3
.... modality SΣI1..1CodingThe modality of the instances in the series
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
.... description ΣI0..1stringA short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances ΣI0..1unsignedIntNumber of Series Related Instances
.... endpoint ΣI0..*Reference(Endpoint)Series access endpoint
.... bodySite ΣI0..1CodingBody part examined
Binding: SNOMEDCTBodyStructures (example)
.... laterality ΣI0..1CodingBody part laterality
Binding: Laterality (example)
.... specimen ΣI0..*Reference(Specimen)Specimen imaged
.... started ΣI0..1dateTimeWhen the series started
.... performer ΣI0..*BackboneElementWho performed the series
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function ΣI0..1CodeableConceptType of performance
Binding: ImagingStudySeriesPerformerFunction (extensible)
..... actor ΣI1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Who performed the series
.... instance SI0..*BackboneElementA single SOP instance from the series
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uid SI1..1idDICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass SI1..1CodingDICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number I0..1unsignedIntThe number of this instance in the series
Example General: 1
..... title I0..1stringDescription of instance

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ImagingStudy.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImagingStudy.statusrequiredImagingStudyStatus
ImagingStudy.modalityextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
ImagingStudy.subject.typeextensibleResourceType
ImagingStudy.procedureCodeextensiblehttp://www.rsna.org/RadLex_Playbook.aspx
ImagingStudy.reasonCodeexampleProcedureReasonCodes
ImagingStudy.series.modalityextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
ImagingStudy.series.lateralityexampleLaterality
ImagingStudy.series.performer.functionextensibleImagingStudySeriesPerformerFunction
ImagingStudy.series.instance.sopClassextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1

Constraints

Constraints

IdPathDetailsRequirements
dom-2ImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ImagingStudyIf 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-4ImagingStudyIf 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-5ImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ImagingStudyA resource should have narrative for robust management
: text.`div`.exists()
ele-1ImagingStudy.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.modalityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.subject.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.subject.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.subject.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.subject.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.subject.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.subject.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.startedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.referrerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.interpreterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.numberOfSeriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.numberOfInstancesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.procedureReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.procedureCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.series.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.series.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.series.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.series.uidAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.numberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.modalityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.numberOfInstancesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.lateralityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.startedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.performer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.series.performer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.series.performer.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.series.performer.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.series.performer.functionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.performer.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.instanceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.instance.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.series.instance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.series.instance.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImagingStudy.series.instance.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImagingStudy.series.instance.uidAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.instance.sopClassAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.instance.numberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.instance.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())