HL7 FHIR Costa Rica - Reportes de Imágenes Médicas
0.0.1-draft - ci-build
HL7 FHIR Costa Rica - Reportes de Imágenes Médicas, published by Iniciativa HL7 Costa Rica. This guide is not an authorized publication; it is the continuous build for version 0.0.1-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cr/imaging-report/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.or.cr/fhir/imaging-report/StructureDefinition/cr-imaging-study | Version: | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: CRImagingStudy | ||
Copyright/Legal: Utilizado con permiso de HL7 International, todos los derechos reservados Licencia Creative Commons |
||||
Perfil de Estudio de Imagen para Costa Rica. Define los datos requeridos y restricciones para registrar estudios de imagen médica.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ImagingStudy(5.0.0) | A set of images produced in single study (one or more series of references images) | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
Σ | 1..* | Identifier | Identifiers for the whole study |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 |
![]() ![]() |
?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. Required Pattern: available |
![]() ![]() |
Σ | 1..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance. |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who or what is the subject of the study |
![]() ![]() |
Σ | 1..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 |
![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Request fulfilled |
![]() ![]() |
Σ | 1..* | BackboneElement | Each study has one or more series of instances |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| ImagingStudy.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.series.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ImagingStudy.implicitRules, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.identifier.use, ImagingStudy.identifier.system, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.subject, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.series, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.modality | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImagingStudy.modifierExtension, ImagingStudy.series.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ImagingStudy(5.0.0) | A set of images produced in single study (one or more series of references images) | |
![]() ![]() |
1..* | Identifier | Identifiers for the whole study | |
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
![]() ![]() |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Required Pattern: available | |
![]() ![]() |
1..* | CodeableConcept | All of the distinct values for series' modalities | |
![]() ![]() |
1..1 | Reference(Patient) | Who or what is the subject of the study | |
![]() ![]() |
1..1 | dateTime | When the study was started | |
![]() ![]() |
0..* | Reference(ServiceRequest) | Request fulfilled | |
![]() ![]() |
1..* | BackboneElement | Each study has one or more series of instances | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImagingStudy(5.0.0) | A set of images produced in single study (one or more series of references images) | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 1..* | Identifier | Identifiers for the whole study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. Required Pattern: available | ||||
![]() ![]() |
Σ | 1..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance. | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who or what is the subject of the study | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
![]() ![]() |
Σ | 1..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 | ||||
![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Request fulfilled | ||||
![]() ![]() |
Σ | 0..* | Reference(Procedure) | Part of referenced event | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
![]() ![]() |
Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of Study Related Series | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(PlanDefinition | ActivityDefinition) | The performed procedure or code Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred | ||||
![]() ![]() |
Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the study was requested / performed Binding: ProcedureReasonCodes (example): The reason for the study. | ||||
![]() ![]() |
Σ | 0..* | Annotation | User-defined comments | ||||
![]() ![]() |
Σ | 0..1 | string | Institution-generated description | ||||
![]() ![]() |
Σ | 1..* | BackboneElement | Each study has one or more series of instances | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.). | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Specimen) | Specimen imaged | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the series started | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed the series | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | ||||
![]() ![]() ![]() |
0..* | BackboneElement | A single SOP instance from the series | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Description of instance | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ImagingStudy.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ImagingStudy.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| ImagingStudy.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.procedure | Base | preferred |
LOINC/RSNA Radiology Playbook
|
∅ | tx.fhir.org |
| ImagingStudy.reason | Base | example | Procedure Reason Codes | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.series.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.laterality | Base | example |
Laterality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.series.performer.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.instance.sopClass | Base | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ImagingStudy.meta, ImagingStudy.implicitRules, ImagingStudy.language, ImagingStudy.text, ImagingStudy.extension, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.identifier.extension, ImagingStudy.identifier.use, ImagingStudy.identifier.type, ImagingStudy.identifier.system, ImagingStudy.identifier.value, ImagingStudy.identifier.period, ImagingStudy.identifier.assigner, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.subject, ImagingStudy.encounter, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.partOf, ImagingStudy.referrer, ImagingStudy.endpoint, ImagingStudy.numberOfSeries, ImagingStudy.numberOfInstances, ImagingStudy.procedure, ImagingStudy.location, ImagingStudy.reason, ImagingStudy.note, ImagingStudy.description, ImagingStudy.series, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.number, ImagingStudy.series.modality, ImagingStudy.series.description, ImagingStudy.series.numberOfInstances, ImagingStudy.series.endpoint, ImagingStudy.series.bodySite, ImagingStudy.series.laterality, ImagingStudy.series.specimen, ImagingStudy.series.started, ImagingStudy.series.performer, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.function, ImagingStudy.series.performer.actor, ImagingStudy.series.instance, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.uid, ImagingStudy.series.instance.sopClass, ImagingStudy.series.instance.number, ImagingStudy.series.instance.title | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImagingStudy.extension, ImagingStudy.modifierExtension, ImagingStudy.identifier.extension, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ImagingStudy
Summary
Mandatory: 4 elements
Structures
This structure refers to these other structures:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ImagingStudy(5.0.0) | A set of images produced in single study (one or more series of references images) | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
Σ | 1..* | Identifier | Identifiers for the whole study |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 |
![]() ![]() |
?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. Required Pattern: available |
![]() ![]() |
Σ | 1..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance. |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who or what is the subject of the study |
![]() ![]() |
Σ | 1..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 |
![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Request fulfilled |
![]() ![]() |
Σ | 1..* | BackboneElement | Each study has one or more series of instances |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| ImagingStudy.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.series.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ImagingStudy.implicitRules, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.identifier.use, ImagingStudy.identifier.system, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.subject, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.series, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.modality | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImagingStudy.modifierExtension, ImagingStudy.series.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ImagingStudy(5.0.0) | A set of images produced in single study (one or more series of references images) | |
![]() ![]() |
1..* | Identifier | Identifiers for the whole study | |
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
![]() ![]() |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Required Pattern: available | |
![]() ![]() |
1..* | CodeableConcept | All of the distinct values for series' modalities | |
![]() ![]() |
1..1 | Reference(Patient) | Who or what is the subject of the study | |
![]() ![]() |
1..1 | dateTime | When the study was started | |
![]() ![]() |
0..* | Reference(ServiceRequest) | Request fulfilled | |
![]() ![]() |
1..* | BackboneElement | Each study has one or more series of instances | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImagingStudy(5.0.0) | A set of images produced in single study (one or more series of references images) | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 1..* | Identifier | Identifiers for the whole study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. Required Pattern: available | ||||
![]() ![]() |
Σ | 1..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance. | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who or what is the subject of the study | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
![]() ![]() |
Σ | 1..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 | ||||
![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Request fulfilled | ||||
![]() ![]() |
Σ | 0..* | Reference(Procedure) | Part of referenced event | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
![]() ![]() |
Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of Study Related Series | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(PlanDefinition | ActivityDefinition) | The performed procedure or code Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred | ||||
![]() ![]() |
Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the study was requested / performed Binding: ProcedureReasonCodes (example): The reason for the study. | ||||
![]() ![]() |
Σ | 0..* | Annotation | User-defined comments | ||||
![]() ![]() |
Σ | 0..1 | string | Institution-generated description | ||||
![]() ![]() |
Σ | 1..* | BackboneElement | Each study has one or more series of instances | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.). | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Specimen) | Specimen imaged | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the series started | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed the series | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | ||||
![]() ![]() ![]() |
0..* | BackboneElement | A single SOP instance from the series | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Description of instance | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ImagingStudy.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ImagingStudy.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ImagingStudy.status | Base | required | Imaging Study Status | 📍5.0.0 | FHIR Std. |
| ImagingStudy.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.procedure | Base | preferred |
LOINC/RSNA Radiology Playbook
|
∅ | tx.fhir.org |
| ImagingStudy.reason | Base | example | Procedure Reason Codes | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.modality | Base | extensible |
Modality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.series.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.laterality | Base | example |
Laterality
|
⏿2025.3.20250714 | tx.fhir.org |
| ImagingStudy.series.performer.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingStudy.series.instance.sopClass | Base | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ImagingStudy.meta, ImagingStudy.implicitRules, ImagingStudy.language, ImagingStudy.text, ImagingStudy.extension, ImagingStudy.modifierExtension, ImagingStudy.identifier, ImagingStudy.identifier.extension, ImagingStudy.identifier.use, ImagingStudy.identifier.type, ImagingStudy.identifier.system, ImagingStudy.identifier.value, ImagingStudy.identifier.period, ImagingStudy.identifier.assigner, ImagingStudy.status, ImagingStudy.modality, ImagingStudy.subject, ImagingStudy.encounter, ImagingStudy.started, ImagingStudy.basedOn, ImagingStudy.partOf, ImagingStudy.referrer, ImagingStudy.endpoint, ImagingStudy.numberOfSeries, ImagingStudy.numberOfInstances, ImagingStudy.procedure, ImagingStudy.location, ImagingStudy.reason, ImagingStudy.note, ImagingStudy.description, ImagingStudy.series, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.uid, ImagingStudy.series.number, ImagingStudy.series.modality, ImagingStudy.series.description, ImagingStudy.series.numberOfInstances, ImagingStudy.series.endpoint, ImagingStudy.series.bodySite, ImagingStudy.series.laterality, ImagingStudy.series.specimen, ImagingStudy.series.started, ImagingStudy.series.performer, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.performer.function, ImagingStudy.series.performer.actor, ImagingStudy.series.instance, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension, ImagingStudy.series.instance.uid, ImagingStudy.series.instance.sopClass, ImagingStudy.series.instance.number, ImagingStudy.series.instance.title | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImagingStudy.extension, ImagingStudy.modifierExtension, ImagingStudy.identifier.extension, ImagingStudy.series.extension, ImagingStudy.series.modifierExtension, ImagingStudy.series.performer.extension, ImagingStudy.series.performer.modifierExtension, ImagingStudy.series.instance.extension, ImagingStudy.series.instance.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ImagingStudy
Summary
Mandatory: 4 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron