FHIRcast
3.0.0-ballot - ci-build
FHIRcast
3.0.0-ballot - ci-build
FHIRcast, published by HL7 International / Infrastructure And Messaging. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhircast-docs/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/fhircast/StructureDefinition/fhircast-imaging-study-open | Version: 3.0.0-ballot | |||
| Draft as of 2024-12-19 | Computable Name: FHIRcastImagingStudyOpen | |||
Provides guidance as to which ImagingStudy attributes should be present and considerations as to how each attribute should be valued in all [FHIR resource]-open events.
At least one business identifier of the ImagingStudy SHALL be provided in a [FHIR resource]-open request. Two business identifiers are typically associated with an image study. Imaging systems such as a PACS viewer, advanced visualization workstation, etc. typically identify an image study by its DICOM Study Instance UID (which in DICOM is identified with a (0020,000D) tag). Likewise, information systems often identify an image study through the accession number of the order which triggered the image procedure to be performed.
The Study Instance UID SHALL be included as a business identifier if it is known. In FHIR, the Study Instance UID of an ImagingStudy is provided in the identifier array using the identifier system of urn:dicom:uid and prefixing the UID value with urn:oid:.
The accession number SHALL be included as a business identifier if it is known.
FHIR R4 versus FHIR R5
Relative to FHIR R4, the ImagingStudy resource's change relevant to FHIRcast is the guidance FHIR R5 provides in specifying the accession number. In FHIR R4, the guidance is to provide the accession number in the identifier array. In FHIR R5, the accession number is provided in the ImagingStudy's basedOn array as a reference using a ServiceRequest reference type.
Since this version of FHIRcast promotes the use of FHIR R4 resources, the guidance to provide the accession number in the identifier array SHOULD be used and this approach is shown in all ImagingStudy examples in the FHIRcast specification. However, if Subscribers agree to use FHIR R5 resources, the FHIR R5 recommendation MAY be used.
For a more detailed explanation of these business identifiers, see the FHIR R4 implementation notes of the FHIR ImagingStudy resource (and the FHIR R5 implementation notes of the FHIR ImagingStudy resource). Ideally both the accession number and Study Instance UID are available and present in an ImagingStudy resource used in FHIRcast. The presence of both business identifiers ensures that all Subscribers will be able to be able to identify the appropriate imaging study.
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 |
ImagingStudy | |||
  id |
1..1 | id | A logical id of the resource SHALL be provided. | |
| identifier |
1..* | Identifier | At least one business identifier of the ImagingStudy SHALL be provided in a [FHIR resource]-open request (see this event's detailed description for more information). | |
| status |
1..1 | code | Status of the ImagingStudy, note this may not be known and hence have a value of `unknown`; however, `status` is included since it is required by the FHIR standard | |
  subject |
1..1 | Reference(FHIRcast Patient for Open Events | Device | Group) | Reference to the Patient resource associated with the ImagingStudy (see detailed description if the image study's subject is not a patient) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy |
0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
 id |
Σ | 1..1 | id | A logical id of the resource SHALL be provided. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
Σ | 1..* | Identifier | At least one business identifier of the ImagingStudy SHALL be provided in a [FHIR resource]-open request (see this event's detailed description for more information). ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | Status of the ImagingStudy, note this may not be known and hence have a value of `unknown`; however, `status` is included since it is required by the FHIR standard Binding: ImagingStudyStatus (required): The status of the ImagingStudy. ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 1..1 | Reference(FHIRcast Patient for Open Events | Device | Group) | Reference to the Patient resource associated with the ImagingStudy (see detailed description if the image study's subject is not a patient) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1from the FHIR Standard |
| 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 | A set of images produced in single study (one or more series of references images) | |||||
| id |
Σ | 1..1 | id | A logical id of the resource SHALL be provided. | ||||
| 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 | ||||
| identifier |
Σ | 1..* | Identifier | At least one business identifier of the ImagingStudy SHALL be provided in a [FHIR resource]-open request (see this event's detailed description for more information). | ||||
| status |
?!Σ | 1..1 | code | Status of the ImagingStudy, note this may not be known and hence have a value of `unknown`; however, `status` is included since it is required by the FHIR standard 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 |
Σ | 1..1 | Reference(FHIRcast Patient for Open Events | Device | Group) | Reference to the Patient resource associated with the ImagingStudy (see detailed description if the image study's subject is not a patient) | ||||
| 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 |
Σ | 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 |
Σ | 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 | 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 |
Σ | 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 |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | 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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | |||||
| 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 | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1from 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-reasonfrom 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-sitefrom the FHIR Standard | ||||
| ImagingStudy.series.laterality | example | Lateralityhttp://hl7.org/fhir/ValueSet/bodysite-lateralityfrom the FHIR Standard | ||||
| ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunctionhttp://hl7.org/fhir/ValueSet/series-performer-functionfrom 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
Differential View
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy |
ImagingStudy | |||
| id |
1..1 | id | A logical id of the resource SHALL be provided. | |
| identifier |
1..* | Identifier | At least one business identifier of the ImagingStudy SHALL be provided in a [FHIR resource]-open request (see this event's detailed description for more information). | |
| status |
1..1 | code | Status of the ImagingStudy, note this may not be known and hence have a value of `unknown`; however, `status` is included since it is required by the FHIR standard | |
| subject |
1..1 | Reference(FHIRcast Patient for Open Events | Device | Group) | Reference to the Patient resource associated with the ImagingStudy (see detailed description if the image study's subject is not a patient) | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy |
0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| id |
Σ | 1..1 | id | A logical id of the resource SHALL be provided. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
Σ | 1..* | Identifier | At least one business identifier of the ImagingStudy SHALL be provided in a [FHIR resource]-open request (see this event's detailed description for more information). ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | Status of the ImagingStudy, note this may not be known and hence have a value of `unknown`; however, `status` is included since it is required by the FHIR standard Binding: ImagingStudyStatus (required): The status of the ImagingStudy. ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 1..1 | Reference(FHIRcast Patient for Open Events | Device | Group) | Reference to the Patient resource associated with the ImagingStudy (see detailed description if the image study's subject is not a patient) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1from the FHIR Standard |
| 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 | A set of images produced in single study (one or more series of references images) | |||||
| id |
Σ | 1..1 | id | A logical id of the resource SHALL be provided. | ||||
| 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 | ||||
| identifier |
Σ | 1..* | Identifier | At least one business identifier of the ImagingStudy SHALL be provided in a [FHIR resource]-open request (see this event's detailed description for more information). | ||||
| status |
?!Σ | 1..1 | code | Status of the ImagingStudy, note this may not be known and hence have a value of `unknown`; however, `status` is included since it is required by the FHIR standard 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 |
Σ | 1..1 | Reference(FHIRcast Patient for Open Events | Device | Group) | Reference to the Patient resource associated with the ImagingStudy (see detailed description if the image study's subject is not a patient) | ||||
| 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 |
Σ | 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 |
Σ | 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 | 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 |
Σ | 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 |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | 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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | |||||
| 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 | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1from 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-reasonfrom 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-sitefrom the FHIR Standard | ||||
| ImagingStudy.series.laterality | example | Lateralityhttp://hl7.org/fhir/ValueSet/bodysite-lateralityfrom the FHIR Standard | ||||
| ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunctionhttp://hl7.org/fhir/ValueSet/series-performer-functionfrom 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
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 International / Infrastructure And Messaging. Package hl7.fhir.uv.fhircast#3.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change