Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_ImagingStudy_R5

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-ImagingStudy Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_ImagingStudy_R5

This cross-version profile allows STU3 ImagingStudy content to be represented via FHIR R5 ImagingStudy resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(5.0.0) A set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
Constraints: ext-1
.... extension:interpreter 0..* Reference(Cross-version Profile for STU3.Practitioner for use in FHIR R5(0.1.0) | Practitioner) STU3: Who interpreted images (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.interpreter
Constraints: ext-1
.... extension:procedureReference 0..* Reference(Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: The performed Procedure reference (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureReference
Constraints: ext-1
.... extension:procedureCode 0..* CodeableConcept STU3: The performed procedure code (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureCode
Constraints: ext-1
.... extension:reason 0..1 CodeableConcept STU3: Why the study was requested (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: Who the images are of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required Imaging Study Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy 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 ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImagingStudy.implicitRules, ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.status, ImagingStudy.subject, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient, ImagingStudy.subject.reference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(5.0.0) A set of images produced in single study (one or more series of references images)
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
.... extension:interpreter 0..* Reference(Cross-version Profile for STU3.Practitioner for use in FHIR R5(0.1.0) | Practitioner) STU3: Who interpreted images (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.interpreter
.... extension:procedureReference 0..* Reference(Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: The performed Procedure reference (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureReference
.... extension:procedureCode 0..* CodeableConcept STU3: The performed procedure code (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureCode
.... extension:reason 0..1 CodeableConcept STU3: Why the study was requested (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.reason
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:uid 1..1 oid STU3: Formal DICOM identifier for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.uid
..... extension:accession 0..1 Identifier STU3: Related workflow identifier ("Accession Number") additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.accession
..... extension:identifier 0..* Identifier STU3: Other identifiers for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.identifier
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) STU3: Who the images are of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) STU3: Originating context additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* Reference(Resource) STU3: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... referrer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:referrer 0..1 Reference(Resource) STU3: referrer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... endpoint
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:endpoint 0..* Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... series
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
.... endpoint
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:endpoint 0..* Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... bodySite
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:bodySite 0..1 Coding STU3: bodySite additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.bodySite
.... instance
..... sopClass
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sopClass 0..1 oid STU3: sopClass additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.instance.sopClass

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(5.0.0) A set of images produced in single study (one or more series of references images)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
Constraints: ext-1
.... extension:interpreter 0..* Reference(Cross-version Profile for STU3.Practitioner for use in FHIR R5(0.1.0) | Practitioner) STU3: Who interpreted images (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.interpreter
Constraints: ext-1
.... extension:procedureReference 0..* Reference(Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: The performed Procedure reference (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureReference
Constraints: ext-1
.... extension:procedureCode 0..* CodeableConcept STU3: The performed procedure code (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureCode
Constraints: ext-1
.... extension:reason 0..1 CodeableConcept STU3: Why the study was requested (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifiers for the whole study
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:uid 1..1 oid STU3: Formal DICOM identifier for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.uid
Constraints: ext-1
..... extension:accession 0..1 Identifier STU3: Related workflow identifier ("Accession Number") additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.accession
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: Other identifiers for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* CodeableConcept All of the distinct values for series' modalities
Binding: Modality . (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: Who the images are of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) STU3: Originating context additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... started Σ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:basedOn 0..1 Reference(Resource) STU3: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Procedure) Part of referenced event
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:referrer 0..1 Reference(Resource) STU3: referrer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... endpoint Σ 0..* Reference(Endpoint) Study access endpoint
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:endpoint 0..1 Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... numberOfSeries Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedure Σ 0..* CodeableReference(PlanDefinition | ActivityDefinition) The performed procedure or code
Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reason Σ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) Why the study was requested / performed
Binding: ProcedureReasonCodes (example): The reason for the study.
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series Σ 0..* BackboneElement Each study has one or more series of instances
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... uid Σ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality Σ 1..1 CodeableConcept The modality used for this series
Binding: Modality . (extensible): Type of acquired data in the instance.
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... endpoint Σ 0..* Reference(Endpoint) Series access endpoint
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:endpoint 0..1 Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... bodySite Σ 0..1 CodeableReference(BodyStructure) Body part examined
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:bodySite 0..1 Coding STU3: bodySite additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.bodySite
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... laterality Σ 0..1 CodeableConcept Body part laterality
Binding: Laterality . (example): Codes describing body site laterality (left, right, etc.).
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... performer Σ 0..* BackboneElement Who performed the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... function Σ 0..1 CodeableConcept Type of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) Who performed the series
.... instance 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... uid 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass 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.
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:sopClass 1..1 oid STU3: sopClass additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.instance.sopClass
Constraints: ext-1
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... number 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
ImagingStudy.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
ImagingStudy.language Base required All Languages 📍5.0.0 FHIR Std.
ImagingStudy.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
ImagingStudy.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
ImagingStudy.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
ImagingStudy.status Base required Imaging Study Status 📍5.0.0 FHIR Std.
ImagingStudy.modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.subject.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.encounter.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.basedOn.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.referrer.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.endpoint.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.procedure Base preferred LOINC/RSNA Radiology Playbook . tx.fhir.org
ImagingStudy.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.
ImagingStudy.series.​modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​endpoint.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.series.​bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
ImagingStudy.series.​laterality Base example Laterality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy 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 ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImagingStudy.meta, ImagingStudy.meta.extension, ImagingStudy.meta.extension:meta, ImagingStudy.meta.versionId, ImagingStudy.meta.lastUpdated, ImagingStudy.meta.source, ImagingStudy.meta.profile, ImagingStudy.meta.security, ImagingStudy.meta.tag, ImagingStudy.implicitRules, ImagingStudy.language, ImagingStudy.text, ImagingStudy.text.extension, ImagingStudy.text.extension:text, ImagingStudy.text.status, ImagingStudy.text.div, ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.identifier.extension, ImagingStudy.identifier.extension:uid, ImagingStudy.identifier.extension:accession, ImagingStudy.identifier.extension:identifier, ImagingStudy.identifier.use, ImagingStudy.identifier.type, ImagingStudy.identifier.system, ImagingStudy.identifier.value, ImagingStudy.identifier.period, ImagingStudy.identifier.assigner, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.subject, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient, ImagingStudy.subject.reference, ImagingStudy.subject.type, ImagingStudy.subject.identifier, ImagingStudy.subject.display, ImagingStudy.encounter, ImagingStudy.encounter.extension, ImagingStudy.encounter.extension:context, ImagingStudy.encounter.reference, ImagingStudy.encounter.type, ImagingStudy.encounter.identifier, ImagingStudy.encounter.display, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.basedOn.extension, ImagingStudy.basedOn.extension:basedOn, ImagingStudy.basedOn.reference, ImagingStudy.basedOn.type, ImagingStudy.basedOn.identifier, ImagingStudy.basedOn.display, ImagingStudy.partOf, ImagingStudy.referrer, ImagingStudy.referrer.extension, ImagingStudy.referrer.extension:referrer, ImagingStudy.referrer.reference, ImagingStudy.referrer.type, ImagingStudy.referrer.identifier, ImagingStudy.referrer.display, ImagingStudy.endpoint, ImagingStudy.endpoint.extension, ImagingStudy.endpoint.extension:endpoint, ImagingStudy.endpoint.reference, ImagingStudy.endpoint.type, ImagingStudy.endpoint.identifier, ImagingStudy.endpoint.display, ImagingStudy.numberOfSeries, ImagingStudy.numberOfInstances, ImagingStudy.procedure, ImagingStudy.location, ImagingStudy.reason, ImagingStudy.note, ImagingStudy.description, ImagingStudy.series, ImagingStudy.series.extension, ImagingStudy.series.extension:availability, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.number, ImagingStudy.series.modality, ImagingStudy.series.description, ImagingStudy.series.numberOfInstances, ImagingStudy.series.endpoint, ImagingStudy.series.endpoint.extension, ImagingStudy.series.endpoint.extension:endpoint, ImagingStudy.series.endpoint.reference, ImagingStudy.series.endpoint.type, ImagingStudy.series.endpoint.identifier, ImagingStudy.series.endpoint.display, ImagingStudy.series.bodySite, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.bodySite.concept, ImagingStudy.series.bodySite.reference, ImagingStudy.series.laterality, ImagingStudy.series.specimen, ImagingStudy.series.started, ImagingStudy.series.performer, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.function, ImagingStudy.series.performer.actor, ImagingStudy.series.instance, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.uid, ImagingStudy.series.instance.sopClass, ImagingStudy.series.instance.sopClass.extension, ImagingStudy.series.instance.sopClass.extension:sopClass, ImagingStudy.series.instance.sopClass.system, ImagingStudy.series.instance.sopClass.version, ImagingStudy.series.instance.sopClass.code, ImagingStudy.series.instance.sopClass.display, ImagingStudy.series.instance.sopClass.userSelected, ImagingStudy.series.instance.number, ImagingStudy.series.instance.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.meta.extension, ImagingStudy.meta.extension:meta, ImagingStudy.text.extension, ImagingStudy.text.extension:text, ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.identifier.extension, ImagingStudy.identifier.extension:uid, ImagingStudy.identifier.extension:accession, ImagingStudy.identifier.extension:identifier, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient, ImagingStudy.encounter.extension, ImagingStudy.encounter.extension:context, ImagingStudy.basedOn.extension, ImagingStudy.basedOn.extension:basedOn, ImagingStudy.referrer.extension, ImagingStudy.referrer.extension:referrer, ImagingStudy.endpoint.extension, ImagingStudy.endpoint.extension:endpoint, ImagingStudy.series.extension, ImagingStudy.series.extension:availability, ImagingStudy.series.modifierExtension, ImagingStudy.series.endpoint.extension, ImagingStudy.series.endpoint.extension:endpoint, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.sopClass.extension, ImagingStudy.series.instance.sopClass.extension:sopClass Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error ImagingStudy.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error ImagingStudy.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(5.0.0) A set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
Constraints: ext-1
.... extension:interpreter 0..* Reference(Cross-version Profile for STU3.Practitioner for use in FHIR R5(0.1.0) | Practitioner) STU3: Who interpreted images (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.interpreter
Constraints: ext-1
.... extension:procedureReference 0..* Reference(Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: The performed Procedure reference (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureReference
Constraints: ext-1
.... extension:procedureCode 0..* CodeableConcept STU3: The performed procedure code (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureCode
Constraints: ext-1
.... extension:reason 0..1 CodeableConcept STU3: Why the study was requested (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: Who the images are of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required Imaging Study Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy 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 ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImagingStudy.implicitRules, ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.status, ImagingStudy.subject, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient, ImagingStudy.subject.reference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(5.0.0) A set of images produced in single study (one or more series of references images)
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
.... extension:interpreter 0..* Reference(Cross-version Profile for STU3.Practitioner for use in FHIR R5(0.1.0) | Practitioner) STU3: Who interpreted images (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.interpreter
.... extension:procedureReference 0..* Reference(Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: The performed Procedure reference (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureReference
.... extension:procedureCode 0..* CodeableConcept STU3: The performed procedure code (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureCode
.... extension:reason 0..1 CodeableConcept STU3: Why the study was requested (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.reason
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:uid 1..1 oid STU3: Formal DICOM identifier for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.uid
..... extension:accession 0..1 Identifier STU3: Related workflow identifier ("Accession Number") additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.accession
..... extension:identifier 0..* Identifier STU3: Other identifiers for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.identifier
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) STU3: Who the images are of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) STU3: Originating context additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* Reference(Resource) STU3: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... referrer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:referrer 0..1 Reference(Resource) STU3: referrer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... endpoint
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:endpoint 0..* Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... series
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
.... endpoint
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:endpoint 0..* Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... bodySite
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:bodySite 0..1 Coding STU3: bodySite additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.bodySite
.... instance
..... sopClass
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:sopClass 0..1 oid STU3: sopClass additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.instance.sopClass

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy(5.0.0) A set of images produced in single study (one or more series of references images)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
Constraints: ext-1
.... extension:interpreter 0..* Reference(Cross-version Profile for STU3.Practitioner for use in FHIR R5(0.1.0) | Practitioner) STU3: Who interpreted images (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.interpreter
Constraints: ext-1
.... extension:procedureReference 0..* Reference(Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: The performed Procedure reference (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureReference
Constraints: ext-1
.... extension:procedureCode 0..* CodeableConcept STU3: The performed procedure code (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.procedureCode
Constraints: ext-1
.... extension:reason 0..1 CodeableConcept STU3: Why the study was requested (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.reason
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifiers for the whole study
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:uid 1..1 oid STU3: Formal DICOM identifier for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.uid
Constraints: ext-1
..... extension:accession 0..1 Identifier STU3: Related workflow identifier ("Accession Number") additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.accession
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: Other identifiers for the study additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* CodeableConcept All of the distinct values for series' modalities
Binding: Modality . (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(Patient | Device | Group) Who or what is the subject of the study
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: Who the images are of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) STU3: Originating context additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... started Σ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:basedOn 0..1 Reference(Resource) STU3: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Procedure) Part of referenced event
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:referrer 0..1 Reference(Resource) STU3: referrer additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... endpoint Σ 0..* Reference(Endpoint) Study access endpoint
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:endpoint 0..1 Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... numberOfSeries Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedure Σ 0..* CodeableReference(PlanDefinition | ActivityDefinition) The performed procedure or code
Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reason Σ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) Why the study was requested / performed
Binding: ProcedureReasonCodes (example): The reason for the study.
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series Σ 0..* BackboneElement Each study has one or more series of instances
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:availability 0..1 code STU3: ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.availability
Binding: R3InstanceAvailabilityForR5 (0.1.0) (required): Availability of the resource
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... uid Σ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality Σ 1..1 CodeableConcept The modality used for this series
Binding: Modality . (extensible): Type of acquired data in the instance.
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... endpoint Σ 0..* Reference(Endpoint) Series access endpoint
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:endpoint 0..1 Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... bodySite Σ 0..1 CodeableReference(BodyStructure) Body part examined
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:bodySite 0..1 Coding STU3: bodySite additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.bodySite
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... laterality Σ 0..1 CodeableConcept Body part laterality
Binding: Laterality . (example): Codes describing body site laterality (left, right, etc.).
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... performer Σ 0..* BackboneElement Who performed the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... function Σ 0..1 CodeableConcept Type of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) Who performed the series
.... instance 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... uid 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass 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.
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:sopClass 1..1 oid STU3: sopClass additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImagingStudy.series.instance.sopClass
Constraints: ext-1
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... number 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
ImagingStudy.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
ImagingStudy.language Base required All Languages 📍5.0.0 FHIR Std.
ImagingStudy.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
ImagingStudy.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
ImagingStudy.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
ImagingStudy.status Base required Imaging Study Status 📍5.0.0 FHIR Std.
ImagingStudy.modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.subject.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.encounter.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.basedOn.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.referrer.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.endpoint.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.procedure Base preferred LOINC/RSNA Radiology Playbook . tx.fhir.org
ImagingStudy.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.
ImagingStudy.series.​modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​endpoint.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
ImagingStudy.series.​bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
ImagingStudy.series.​laterality Base example Laterality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy 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 ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImagingStudy.meta, ImagingStudy.meta.extension, ImagingStudy.meta.extension:meta, ImagingStudy.meta.versionId, ImagingStudy.meta.lastUpdated, ImagingStudy.meta.source, ImagingStudy.meta.profile, ImagingStudy.meta.security, ImagingStudy.meta.tag, ImagingStudy.implicitRules, ImagingStudy.language, ImagingStudy.text, ImagingStudy.text.extension, ImagingStudy.text.extension:text, ImagingStudy.text.status, ImagingStudy.text.div, ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.identifier.extension, ImagingStudy.identifier.extension:uid, ImagingStudy.identifier.extension:accession, ImagingStudy.identifier.extension:identifier, ImagingStudy.identifier.use, ImagingStudy.identifier.type, ImagingStudy.identifier.system, ImagingStudy.identifier.value, ImagingStudy.identifier.period, ImagingStudy.identifier.assigner, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.subject, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient, ImagingStudy.subject.reference, ImagingStudy.subject.type, ImagingStudy.subject.identifier, ImagingStudy.subject.display, ImagingStudy.encounter, ImagingStudy.encounter.extension, ImagingStudy.encounter.extension:context, ImagingStudy.encounter.reference, ImagingStudy.encounter.type, ImagingStudy.encounter.identifier, ImagingStudy.encounter.display, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.basedOn.extension, ImagingStudy.basedOn.extension:basedOn, ImagingStudy.basedOn.reference, ImagingStudy.basedOn.type, ImagingStudy.basedOn.identifier, ImagingStudy.basedOn.display, ImagingStudy.partOf, ImagingStudy.referrer, ImagingStudy.referrer.extension, ImagingStudy.referrer.extension:referrer, ImagingStudy.referrer.reference, ImagingStudy.referrer.type, ImagingStudy.referrer.identifier, ImagingStudy.referrer.display, ImagingStudy.endpoint, ImagingStudy.endpoint.extension, ImagingStudy.endpoint.extension:endpoint, ImagingStudy.endpoint.reference, ImagingStudy.endpoint.type, ImagingStudy.endpoint.identifier, ImagingStudy.endpoint.display, ImagingStudy.numberOfSeries, ImagingStudy.numberOfInstances, ImagingStudy.procedure, ImagingStudy.location, ImagingStudy.reason, ImagingStudy.note, ImagingStudy.description, ImagingStudy.series, ImagingStudy.series.extension, ImagingStudy.series.extension:availability, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.number, ImagingStudy.series.modality, ImagingStudy.series.description, ImagingStudy.series.numberOfInstances, ImagingStudy.series.endpoint, ImagingStudy.series.endpoint.extension, ImagingStudy.series.endpoint.extension:endpoint, ImagingStudy.series.endpoint.reference, ImagingStudy.series.endpoint.type, ImagingStudy.series.endpoint.identifier, ImagingStudy.series.endpoint.display, ImagingStudy.series.bodySite, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.bodySite.concept, ImagingStudy.series.bodySite.reference, ImagingStudy.series.laterality, ImagingStudy.series.specimen, ImagingStudy.series.started, ImagingStudy.series.performer, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.function, ImagingStudy.series.performer.actor, ImagingStudy.series.instance, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.uid, ImagingStudy.series.instance.sopClass, ImagingStudy.series.instance.sopClass.extension, ImagingStudy.series.instance.sopClass.extension:sopClass, ImagingStudy.series.instance.sopClass.system, ImagingStudy.series.instance.sopClass.version, ImagingStudy.series.instance.sopClass.code, ImagingStudy.series.instance.sopClass.display, ImagingStudy.series.instance.sopClass.userSelected, ImagingStudy.series.instance.number, ImagingStudy.series.instance.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImagingStudy.meta.extension, ImagingStudy.meta.extension:meta, ImagingStudy.text.extension, ImagingStudy.text.extension:text, ImagingStudy.extension, ImagingStudy.extension:availability, ImagingStudy.extension:interpreter, ImagingStudy.extension:procedureReference, ImagingStudy.extension:procedureCode, ImagingStudy.extension:reason, ImagingStudy.modifierExtension, ImagingStudy.identifier.extension, ImagingStudy.identifier.extension:uid, ImagingStudy.identifier.extension:accession, ImagingStudy.identifier.extension:identifier, ImagingStudy.subject.extension, ImagingStudy.subject.extension:patient, ImagingStudy.encounter.extension, ImagingStudy.encounter.extension:context, ImagingStudy.basedOn.extension, ImagingStudy.basedOn.extension:basedOn, ImagingStudy.referrer.extension, ImagingStudy.referrer.extension:referrer, ImagingStudy.endpoint.extension, ImagingStudy.endpoint.extension:endpoint, ImagingStudy.series.extension, ImagingStudy.series.extension:availability, ImagingStudy.series.modifierExtension, ImagingStudy.series.endpoint.extension, ImagingStudy.series.endpoint.extension:endpoint, ImagingStudy.series.bodySite.extension, ImagingStudy.series.bodySite.extension:bodySite, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.sopClass.extension, ImagingStudy.series.instance.sopClass.extension:sopClass Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error ImagingStudy.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error ImagingStudy.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron