International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

Resource Profile: ImagingStudy (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips Version: 2.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: 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.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..* ImagingStudy 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-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 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
... identifier SΣ 0..* Identifier Identifiers for the whole study
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Patient (IPS)) Who or what is the subject of the study
ele-1: All FHIR elements must have a @value or children
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... started SΣ 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
... procedureCode SΣ 0..* CodeableConceptIPS The performed procedure code
Binding: Results Radiology Observation - IPS (extensible)
ele-1: All FHIR elements must have a @value or children
... reasonCode SΣ 0..* CodeableConceptIPS Why the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.


ele-1: All FHIR elements must have a @value or children
... series SΣ 0..* BackboneElement Each study has one or more series of instances
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
ele-1: All FHIR elements must have a @value or children
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.


ele-1: All FHIR elements must have a @value or children
.... instance S 0..* BackboneElement A single SOP instance from the series
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... uid S 1..1 id DICOM SOP Instance UID
ele-1: All FHIR elements must have a @value or children
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImagingStudy.statusrequiredImagingStudyStatusUvIps
http://hl7.org/fhir/uv/ips/ValueSet/imaging-study-status-uv-ips
from this IG
ImagingStudy.procedureCodeextensibleResultsRadiologyObservationUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ips
from this IG
ImagingStudy.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
ImagingStudy.series.modalityextensibleAcquisitionModality .
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
ImagingStudy.series.instance.sopClassextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1
http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron