CH RAD-Order (R4)
0.1.0 - ci-build

CH RAD-Order (R4), published by HL7 Switzerland. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/hl7ch/ch-rad-order/ and changes regularly. See the Directory of published versions

Resource Profile: CH RAD-Order ImagingStudy

Defining URL:http://fhir.ch/ig/ch-rad-order/StructureDefinition/ch-rad-order-imagingstudy
Version:0.1.0
Name:ChRadOrderImagingStudy
Title:CH RAD-Order ImagingStudy
Status:Active as of 2021-06-10T05:22:34+00:00
Definition:

Definition for the ImagingStudy resource in the context of CH RAD-Order.

Publisher:HL7 Switzerland
Copyright:

CC-BY-SA-4.0

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-rad-order/StructureDefinition/ch-rad-order-imagingstudy

Formal Views of Profile Content

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

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..*ImagingStudyCH RAD-Order ImagingStudy
... status S1..1coderegistered | available | cancelled | entered-in-error | unknown
... subject S1..1Reference(CH Core Patient Profile | Device | Group)Who or what is the subject of the study
... 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
.... performer S0..*BackboneElementWho performed the series
..... actor S1..1Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | CareTeam | CH Core Patient Profile | Device | RelatedPerson)Who performed 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 0..*ImagingStudyCH RAD-Order ImagingStudy
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers for the whole study
... status ?!SΣ1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.

... modality Σ0..*CodingAll series modality if actual acquisition modalities
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance.


... subject SΣ1..1Reference(CH Core Patient Profile | Device | Group)Who or what is the subject of the study
... encounter Σ0..1Reference(Encounter)Encounter with which this imaging study is associated
... started Σ0..1dateTimeWhen the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)Request fulfilled
... referrer Σ0..1Reference(Practitioner | PractitionerRole)Referring physician
... interpreter Σ0..*Reference(Practitioner | PractitionerRole)Who interpreted images
... endpoint Σ0..*Reference(Endpoint)Study access endpoint
... numberOfSeries Σ0..1unsignedIntNumber of Study Related Series
... numberOfInstances Σ0..1unsignedIntNumber of Study Related Instances
... procedureReference Σ0..1Reference(Procedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.


... location Σ0..1Reference(Location)Where ImagingStudy occurred
... reasonCode Σ0..*CodeableConceptWhy the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.


... reasonReference Σ0..*Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)Why was study performed
... note Σ0..*AnnotationUser-defined comments
... description Σ0..1stringInstitution-generated description
... series SΣ0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uid SΣ1..1idDICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ0..1unsignedIntNumeric identifier of this series
Example General: 3
.... modality SΣ1..1CodingThe modality of the instances in the series
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance.

.... description Σ0..1stringA short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ0..1unsignedIntNumber of Series Related Instances
.... endpoint Σ0..*Reference(Endpoint)Series access endpoint
.... bodySite Σ0..1CodingBody part examined
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).

.... specimen Σ0..*Reference(Specimen)Specimen imaged
.... started Σ0..1dateTimeWhen the series started
.... performer SΣ0..*BackboneElementWho performed the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ0..1CodeableConceptType of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.

..... actor SΣ1..1Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | CareTeam | CH Core Patient Profile | Device | RelatedPerson)Who performed the series
.... instance S0..*BackboneElementA single SOP instance from the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uid S1..1idDICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S1..1CodingDICOM 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.

..... number 0..1unsignedIntThe number of this instance in the series
Example General: 1
..... title 0..1stringDescription of instance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..*ImagingStudyCH RAD-Order ImagingStudy
... status ?!Σ1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.

... subject Σ1..1Reference(CH Core Patient Profile | Device | Group)Who or what is the subject of the study
... series Σ0..*BackboneElementEach study has one or more series of instances
.... uid Σ1..1idDICOM Series Instance UID for the series
.... modality Σ1..1CodingThe modality of the instances in the series
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance.

.... performer Σ0..*BackboneElementWho performed the series
..... actor Σ1..1Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | CareTeam | CH Core Patient Profile | Device | RelatedPerson)Who performed the series
.... instance 0..*BackboneElementA single SOP instance from the series
..... uid 1..1idDICOM SOP Instance UID
..... sopClass 1..1CodingDICOM 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.


doco Documentation for this format

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..*ImagingStudyCH RAD-Order ImagingStudy
... status S1..1coderegistered | available | cancelled | entered-in-error | unknown
... subject S1..1Reference(CH Core Patient Profile | Device | Group)Who or what is the subject of the study
... 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
.... performer S0..*BackboneElementWho performed the series
..... actor S1..1Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | CareTeam | CH Core Patient Profile | Device | RelatedPerson)Who performed 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 0..*ImagingStudyCH RAD-Order ImagingStudy
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers for the whole study
... status ?!SΣ1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.

... modality Σ0..*CodingAll series modality if actual acquisition modalities
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance.


... subject SΣ1..1Reference(CH Core Patient Profile | Device | Group)Who or what is the subject of the study
... encounter Σ0..1Reference(Encounter)Encounter with which this imaging study is associated
... started Σ0..1dateTimeWhen the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)Request fulfilled
... referrer Σ0..1Reference(Practitioner | PractitionerRole)Referring physician
... interpreter Σ0..*Reference(Practitioner | PractitionerRole)Who interpreted images
... endpoint Σ0..*Reference(Endpoint)Study access endpoint
... numberOfSeries Σ0..1unsignedIntNumber of Study Related Series
... numberOfInstances Σ0..1unsignedIntNumber of Study Related Instances
... procedureReference Σ0..1Reference(Procedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.


... location Σ0..1Reference(Location)Where ImagingStudy occurred
... reasonCode Σ0..*CodeableConceptWhy the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.


... reasonReference Σ0..*Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)Why was study performed
... note Σ0..*AnnotationUser-defined comments
... description Σ0..1stringInstitution-generated description
... series SΣ0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uid SΣ1..1idDICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ0..1unsignedIntNumeric identifier of this series
Example General: 3
.... modality SΣ1..1CodingThe modality of the instances in the series
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance.

.... description Σ0..1stringA short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ0..1unsignedIntNumber of Series Related Instances
.... endpoint Σ0..*Reference(Endpoint)Series access endpoint
.... bodySite Σ0..1CodingBody part examined
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).

.... specimen Σ0..*Reference(Specimen)Specimen imaged
.... started Σ0..1dateTimeWhen the series started
.... performer SΣ0..*BackboneElementWho performed the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ0..1CodeableConceptType of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.

..... actor SΣ1..1Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | CareTeam | CH Core Patient Profile | Device | RelatedPerson)Who performed the series
.... instance S0..*BackboneElementA single SOP instance from the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uid S1..1idDICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S1..1CodingDICOM 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.

..... number 0..1unsignedIntThe number of this instance in the series
Example General: 1
..... title 0..1stringDescription of instance

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

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.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

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.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())