CH RAD-Order (R4)
2.0.0-ballot - ballot
This page is part of the CH RAD-Order (R4) (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-rad-order/StructureDefinition/ch-rad-order-imagingstudy | Version: 2.0.0-ballot | |||
Active as of 2024-05-17 | Computable Name: ChRadOrderImagingStudy | |||
Copyright/Legal: CC0-1.0 |
Definition for the ImagingStudy resource in the context of CH RAD-Order.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImagingStudy
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | 0..* | ImagingStudy | CH RAD-Order ImagingStudy | |
Slices for identifier | S | 2..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this |
identifier:studyInstanceUid | S | 1..1 | Identifier | Study Instanve UID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:dicom:uid | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
identifier:acsn | S | 1..1 | Identifier | Accession Number Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
status | S | 1..1 | code | registered | available | cancelled | entered-in-error | unknown |
subject | S | 1..1 | Reference(CH Core Patient | Device | Group) | Who or what is the subject of the study |
series | S | 0..* | BackboneElement | Each study has one or more series of instances |
uid | S | 1..1 | id | DICOM Series Instance UID for the series |
modality | S | 1..1 | Coding | The modality of the instances in the series |
performer | S | 0..* | BackboneElement | Who performed the series |
actor | S | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | CareTeam | CH Core Patient | Device | RelatedPerson) | Who performed the series |
instance | S | 0..* | BackboneElement | A single SOP instance from the series |
uid | S | 1..1 | id | DICOM SOP Instance UID |
sopClass | S | 1..1 | Coding | DICOM class type |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | 0..* | ImagingStudy | CH RAD-Order ImagingStudy | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 2..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this |
identifier:studyInstanceUid | SΣ | 1..1 | Identifier | Study Instanve UID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:dicom:uid | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
identifier:acsn | SΣ | 1..1 | Identifier | Accession Number Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. |
subject | SΣ | 1..1 | Reference(CH Core Patient | Device | Group) | Who or what is the subject of the study |
series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. |
performer | SΣ | 0..* | BackboneElement | Who performed the series |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | SΣ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | CareTeam | CH Core Patient | Device | RelatedPerson) | Who performed the series |
instance | S | 0..* | BackboneElement | A single SOP instance from the series |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 |
sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ImagingStudy.identifier:studyInstanceUid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ImagingStudy.identifier:acsn.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard | |
ImagingStudy.series.modality | extensible | AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
Id | Grade | Path(s) | Details | Requirements |
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().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-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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ImagingStudy | 0..* | ImagingStudy | CH RAD-Order ImagingStudy | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 2..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this | ||||
identifier:studyInstanceUid | SΣ | 1..1 | Identifier | Study Instanve UID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:dicom:uid | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
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) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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) | ||||
identifier:acsn | SΣ | 1..1 | Identifier | Accession Number Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
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) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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 | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | ||||
modality | Σ | 0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | ||||
subject | SΣ | 1..1 | Reference(CH Core Patient | Device | Group) | Who or what is the subject of the study | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
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 | ||||
referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | ||||
endpoint | Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
numberOfSeries | Σ | 0..1 | unsignedInt | Number of Study Related Series | ||||
numberOfInstances | Σ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference | ||||
procedureCode | Σ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type. | ||||
location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
reasonCode | Σ | 0..* | CodeableConcept | Why 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..* | Annotation | User-defined comments | ||||
description | Σ | 0..1 | string | Institution-generated description | ||||
series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
uid | SΣ | 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 | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (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 | ||||
bodySite | Σ | 0..1 | Coding | Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
laterality | Σ | 0..1 | Coding | 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 | SΣ | 0..* | BackboneElement | Who performed the series | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
actor | SΣ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | CareTeam | CH Core Patient | Device | RelatedPerson) | Who performed the series | ||||
instance | S | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | ||||
sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | ||||
number | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
title | 0..1 | string | Description of instance | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ImagingStudy.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ImagingStudy.identifier:studyInstanceUid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ImagingStudy.identifier:studyInstanceUid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ImagingStudy.identifier:acsn.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ImagingStudy.identifier:acsn.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard | ||||
ImagingStudy.modality | extensible | AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspxhttp://www.rsna.org/RadLex_Playbook.aspx | ||||
ImagingStudy.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
ImagingStudy.series.modality | extensible | AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
ImagingStudy.series.laterality | example | Lateralityhttp://hl7.org/fhir/ValueSet/bodysite-laterality from the FHIR Standard | ||||
ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunctionhttp://hl7.org/fhir/ValueSet/series-performer-function from the FHIR Standard | ||||
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
Id | Grade | Path(s) | Details | Requirements |
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().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-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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ImagingStudy
Summary
Mandatory: 2 elements
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ImagingStudy
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | 0..* | ImagingStudy | CH RAD-Order ImagingStudy | |
Slices for identifier | S | 2..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this |
identifier:studyInstanceUid | S | 1..1 | Identifier | Study Instanve UID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:dicom:uid | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
identifier:acsn | S | 1..1 | Identifier | Accession Number Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
status | S | 1..1 | code | registered | available | cancelled | entered-in-error | unknown |
subject | S | 1..1 | Reference(CH Core Patient | Device | Group) | Who or what is the subject of the study |
series | S | 0..* | BackboneElement | Each study has one or more series of instances |
uid | S | 1..1 | id | DICOM Series Instance UID for the series |
modality | S | 1..1 | Coding | The modality of the instances in the series |
performer | S | 0..* | BackboneElement | Who performed the series |
actor | S | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | CareTeam | CH Core Patient | Device | RelatedPerson) | Who performed the series |
instance | S | 0..* | BackboneElement | A single SOP instance from the series |
uid | S | 1..1 | id | DICOM SOP Instance UID |
sopClass | S | 1..1 | Coding | DICOM class type |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | 0..* | ImagingStudy | CH RAD-Order ImagingStudy | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 2..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this |
identifier:studyInstanceUid | SΣ | 1..1 | Identifier | Study Instanve UID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:dicom:uid | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
identifier:acsn | SΣ | 1..1 | Identifier | Accession Number Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. |
subject | SΣ | 1..1 | Reference(CH Core Patient | Device | Group) | Who or what is the subject of the study |
series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. |
performer | SΣ | 0..* | BackboneElement | Who performed the series |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | SΣ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | CareTeam | CH Core Patient | Device | RelatedPerson) | Who performed the series |
instance | S | 0..* | BackboneElement | A single SOP instance from the series |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 |
sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ImagingStudy.identifier:studyInstanceUid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ImagingStudy.identifier:acsn.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard | |
ImagingStudy.series.modality | extensible | AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
Id | Grade | Path(s) | Details | Requirements |
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().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-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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ImagingStudy | 0..* | ImagingStudy | CH RAD-Order ImagingStudy | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 2..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this | ||||
identifier:studyInstanceUid | SΣ | 1..1 | Identifier | Study Instanve UID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:dicom:uid | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
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) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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) | ||||
identifier:acsn | SΣ | 1..1 | Identifier | Accession Number Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
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) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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 | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | ||||
modality | Σ | 0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | ||||
subject | SΣ | 1..1 | Reference(CH Core Patient | Device | Group) | Who or what is the subject of the study | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
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 | ||||
referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | ||||
endpoint | Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
numberOfSeries | Σ | 0..1 | unsignedInt | Number of Study Related Series | ||||
numberOfInstances | Σ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference | ||||
procedureCode | Σ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type. | ||||
location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
reasonCode | Σ | 0..* | CodeableConcept | Why 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..* | Annotation | User-defined comments | ||||
description | Σ | 0..1 | string | Institution-generated description | ||||
series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
uid | SΣ | 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 | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (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 | ||||
bodySite | Σ | 0..1 | Coding | Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
laterality | Σ | 0..1 | Coding | 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 | SΣ | 0..* | BackboneElement | Who performed the series | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
actor | SΣ | 1..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | CareTeam | CH Core Patient | Device | RelatedPerson) | Who performed the series | ||||
instance | S | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | ||||
sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | ||||
number | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
title | 0..1 | string | Description of instance | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ImagingStudy.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ImagingStudy.identifier:studyInstanceUid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ImagingStudy.identifier:studyInstanceUid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ImagingStudy.identifier:acsn.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ImagingStudy.identifier:acsn.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1 from the FHIR Standard | ||||
ImagingStudy.modality | extensible | AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspxhttp://www.rsna.org/RadLex_Playbook.aspx | ||||
ImagingStudy.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
ImagingStudy.series.modality | extensible | AcquisitionModality http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
ImagingStudy.series.laterality | example | Lateralityhttp://hl7.org/fhir/ValueSet/bodysite-laterality from the FHIR Standard | ||||
ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunctionhttp://hl7.org/fhir/ValueSet/series-performer-function from the FHIR Standard | ||||
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
Id | Grade | Path(s) | Details | Requirements |
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().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-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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ImagingStudy
Summary
Mandatory: 2 elements
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron