Guía implementación interoperabilidad FHIR sectorial e intersectorial
0.14.0 - ci-build

Guía implementación interoperabilidad FHIR sectorial e intersectorial - Local Development build (v0.14.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HCEU - Imaging Study

Defining URL:https://ohapi-fhir-dev-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileImagingStudyHCEU
Version:0.14.0
Name:ProfileImagingStudyHCEU
Title:HCEU - Imaging Study
Status:Draft as of 2025-08-04 20:23:02-0500
Definition:

Recurso que permite registrar información de una imagen diagnóstica tomada en un examen en el escenario de imagenología

Publisher:minsait - An Indra Company. Secretaría de Salud de Bogotá,
Copyright:

Secretaría de Salud de Bogotá

Source Resource:XML / JSON / Turtle

La URL oficial para este perfil es:

https://ohapi-fhir-dev-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileImagingStudyHCEU

Vistas formales para el perfil

Descripción de perfiles, diferenciales, resumenes y cómo deben ser las representaciones en XML y JSON.

Esta estructura se deriva de ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy ImagingStudy
... id 1..1 id Logical id of this artifact
... Slices for identifier S 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by pattern:official
.... identifier:HISdentifier 1..1 Identifier Identifiers for the whole study
..... use 0..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 0..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/imagingstudies/
..... value 0..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... status 1..1 code registered | available | cancelled | entered-in-error | unknown
Fixed Value: registered
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... encounter 1..1 Reference(HCEU - Intramural - Encounter) Encounter with which this imaging study is associated
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... started 1..1 dateTime When the study was started
... basedOn 1..1 Reference(HCEU - Service Resquest | HCEU - Intramural - Care Plan) Request fulfilled
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... referrer 0..0
... interpreter 0..0
... endpoint 1..* Reference(Endpoint) Study access endpoint
... numberOfSeries 1..1 unsignedInt Number of Study Related Series
... numberOfInstances 1..1 unsignedInt Number of Study Related Instances
... procedureReference 0..0
... procedureCode 0..0
... location 1..1 Reference(HCEU - Intramural - Location) Where ImagingStudy occurred
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... reasonCode 0..0
... reasonReference 1..* Reference(HCEU - Condition) Why was study performed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... id Σ 1..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
... 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Σ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by pattern:official
.... identifier:HISdentifier Σ 1..1 Identifier Identifiers for the whole study
..... 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 .
Fixed Value: usual
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/imagingstudies/
..... value Σ 0..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
Fixed Value: registered
... modality Σ 0..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(HCEU - Patient) Who or what is the subject of the study
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 1..1 Reference(HCEU - Intramural - Encounter) Encounter with which this imaging study is associated
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... started Σ 1..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 1..1 Reference(HCEU - Service Resquest | HCEU - Intramural - Care Plan) Request fulfilled
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... endpoint Σ 1..* Reference(Endpoint) Study access endpoint
... numberOfSeries Σ 1..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 1..1 unsignedInt Number of Study Related Instances
... location Σ 1..1 Reference(HCEU - Intramural - Location) Where ImagingStudy occurred
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reasonReference Σ 1..* Reference(HCEU - Condition) 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... identifier Σ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by pattern:official

doco Documentation for this format

Vista de diferencias

Esta estructura se deriva de ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy ImagingStudy
... id 1..1 id Logical id of this artifact
... Slices for identifier S 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by pattern:official
.... identifier:HISdentifier 1..1 Identifier Identifiers for the whole study
..... use 0..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 0..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/imagingstudies/
..... value 0..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... status 1..1 code registered | available | cancelled | entered-in-error | unknown
Fixed Value: registered
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... encounter 1..1 Reference(HCEU - Intramural - Encounter) Encounter with which this imaging study is associated
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... started 1..1 dateTime When the study was started
... basedOn 1..1 Reference(HCEU - Service Resquest | HCEU - Intramural - Care Plan) Request fulfilled
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... referrer 0..0
... interpreter 0..0
... endpoint 1..* Reference(Endpoint) Study access endpoint
... numberOfSeries 1..1 unsignedInt Number of Study Related Series
... numberOfInstances 1..1 unsignedInt Number of Study Related Instances
... procedureReference 0..0
... procedureCode 0..0
... location 1..1 Reference(HCEU - Intramural - Location) Where ImagingStudy occurred
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... reasonCode 0..0
... reasonReference 1..* Reference(HCEU - Condition) Why was study performed

doco Documentation for this format

Tabla de resumen

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... id Σ 1..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
... 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Σ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by pattern:official
.... identifier:HISdentifier Σ 1..1 Identifier Identifiers for the whole study
..... 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 .
Fixed Value: usual
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/imagingstudies/
..... value Σ 0..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
Fixed Value: registered
... modality Σ 0..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(HCEU - Patient) Who or what is the subject of the study
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 1..1 Reference(HCEU - Intramural - Encounter) Encounter with which this imaging study is associated
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... started Σ 1..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 1..1 Reference(HCEU - Service Resquest | HCEU - Intramural - Care Plan) Request fulfilled
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... endpoint Σ 1..* Reference(Endpoint) Study access endpoint
... numberOfSeries Σ 1..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 1..1 unsignedInt Number of Study Related Instances
... location Σ 1..1 Reference(HCEU - Intramural - Location) Where ImagingStudy occurred
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reasonReference Σ 1..* Reference(HCEU - Condition) 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

doco Documentation for this format

 

Otras representaciones de este perfil: Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
ImagingStudy.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ImagingStudy.identifier:HISdentifier.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ImagingStudy.statusrequiredFixed Value: registered
http://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1
From the FHIR Standard
ImagingStudy.modalityextensibleAcquisitionModality .
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
ImagingStudy.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ImagingStudy.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ImagingStudy.basedOn.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ImagingStudy.location.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ImagingStudy.series.modalityextensibleAcquisitionModality .
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ImagingStudy.series.lateralityexampleLaterality
http://hl7.org/fhir/ValueSet/bodysite-laterality
From the FHIR Standard
ImagingStudy.series.performer.functionextensibleImagingStudySeriesPerformerFunction
http://hl7.org/fhir/ValueSet/series-performer-function
From the FHIR Standard
ImagingStudy.series.instance.sopClassextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1
http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()