This page is part of the HSPC FHIR Implementation Guide (v0.1.0: Daft For Comment Draft) based on FHIR v1.9.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | 0..* | A set of images produced in single study (one or more series of references images) | ||
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
Extension | I | 1..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension ext-1: Must have either extensions or value[x], not both |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Extension | I | 1..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension ext-1: Must have either extensions or value[x], not both |
Extension | I | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension ext-1: Must have either extensions or value[x], not both |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Value of extension | |
Extension | I | 0..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension Binding: HSPC Radiology Associated Precondition value set (example) ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
uid | ∑ | 1..1 | oid | Formal DICOM identifier for the study Example: urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045 |
accession | ∑ | 0..1 | Identifier | Related workflow identifier ("Accession Number") |
identifier | ∑ | 0..* | Identifier | Other identifiers for the study |
availability | ∑ | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE Binding: InstanceAvailability (required) |
modalityList | ∑ | 0..* | Coding | All series modality if actual acquisition modalities Binding: Acquisition Modality Codes (extensible) |
patient | ∑ | 1..1 | Reference(Patient) | Who the images are of |
context | ∑ | 0..1 | Reference(Encounter | EpisodeOfCare) | Originating context |
started | ∑ | 0..1 | dateTime | When the study was started Example: 2011-01-01T11:01:20+03:00 |
basedOn | ∑ | 0..* | Reference(ReferralRequest | CarePlan | DiagnosticRequest | ProcedureRequest) | Request fulfilled |
referrer | ∑ | 0..1 | Reference(Practitioner) | Referring physician |
interpreter | 0..1 | Reference(Profile hspc-provpract) | A person with a formal responsibility in the provisioning of healthcare or related services | |
baseLocation | ∑ | 0..* | BackboneElement | Study access service endpoint |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
type | ∑ | 1..1 | Coding | WADO-RS | WADO-URI | IID Binding: dWebType (extensible) |
url | ∑ | 1..1 | uri | Study access URL |
numberOfSeries | ∑ | 1..1 | unsignedInt | Number of Study Related Series |
numberOfInstances | ∑ | 1..1 | unsignedInt | Number of Study Related Instances |
procedure | ∑ | 0..* | Reference(Procedure) | Type of procedure performed |
reason | ∑ | 0..1 | CodeableConcept | Reason for study Binding: (unbound) (example) |
description | ∑ | 0..1 | string | Institution-generated description |
series | ∑ | 0..* | BackboneElement | Each study has one or more series of instances |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
uid | ∑ | 1..1 | oid | Formal DICOM identifier for this series Example: urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
number | ∑ | 0..1 | unsignedInt | Numeric identifier of this series Example: 3 |
modality | ∑ | 1..1 | Coding | The modality of the instances in the series Binding: Acquisition Modality Codes (extensible) |
description | ∑ | 0..1 | string | A short human readable summary of the series Example: CT Surview 180 |
numberOfInstances | ∑ | 1..1 | unsignedInt | Number of Series Related Instances |
availability | ∑ | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE Binding: InstanceAvailability (required) |
baseLocation | ∑ | 0..* | BackboneElement | Series access endpoint |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
type | ∑ | 1..1 | Coding | WADO-RS | WADO-URI | IID Binding: dWebType (extensible) |
url | ∑ | 1..1 | uri | Series access URL |
bodySite | ∑ | 0..1 | Coding | Body part examined Binding: SNOMED CT Body Structures (example) |
laterality | ∑ | 0..1 | Coding | Body part laterality Binding: Laterality (example) |
started | ∑ | 0..1 | dateTime | When the series started |
instance | 0..* | BackboneElement | A single SOP instance from the series | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
uid | 1..1 | oid | Formal DICOM identifier for this instance Example: urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903 | |
number | 0..1 | unsignedInt | The number of this instance in the series Example: 1 | |
sopClass | 1..1 | oid | DICOM class type Example: urn:oid:1.2.840.10008.5.1.4.1.1.2 | |
title | 0..1 | string | Description of instance | |
Documentation for this format |
ImagingStudy(HSPC Imaging Study) | |
Definition | Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. |
Control | 0..* |
ImagingStudy.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
ImagingStudy.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
ImagingStudy.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
ImagingStudy.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
ImagingStudy.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
ImagingStudy.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
ImagingStudy.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
ImagingStudy.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
ImagingStudy.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
ImagingStudy.extension.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
ImagingStudy.extension.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
ImagingStudy.extension.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
ImagingStudy.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
ImagingStudy.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ImagingStudy.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
ImagingStudy.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.uid | |
Definition | Formal identifier for the study. |
Control | 1..1 |
Type | oid |
Alternate Names | StudyInstanceUID |
Example | urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045 |
ImagingStudy.accession | |
Definition | Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance IHE Radiology Technical Framework Volume 1 Appendix A. |
Control | 0..1 |
Type | Identifier |
Alternate Names | AccessionNumber |
ImagingStudy.identifier | |
Definition | Other identifiers for the study. |
Control | 0..* |
Type | Identifier |
Alternate Names | StudyID |
ImagingStudy.availability | |
Definition | Availability of study (online, offline or nearline). |
Control | 0..1 |
Binding | Availability of the resource The codes SHALL be taken from InstanceAvailability |
Type | code |
Alternate Names | InstanceAvailability |
ImagingStudy.modalityList | |
Definition | A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
Control | 0..* |
Binding | Type of acquired data in the instance The codes SHALL be taken from Acquisition Modality Codes; other codes may be used where these codes are not suitable |
Type | Coding |
Alternate Names | ModalitiesInStudy |
ImagingStudy.patient | |
Definition | The patient imaged in the study. |
Control | 1..1 |
Type | Reference(Patient) |
ImagingStudy.context | |
Definition | The encounter at which the request is initiated. |
Control | 0..1 |
Type | Choice of: Reference(Encounter), Reference(EpisodeOfCare) |
ImagingStudy.started | |
Definition | Date and Time the study started. |
Control | 0..1 |
Type | dateTime |
Alternate Names | StudyDate, StudyTime |
Example | 2011-01-01T11:01:20+03:00 |
ImagingStudy.basedOn | |
Definition | A list of the diagnostic requests that resulted in this imaging study being performed. |
Control | 0..* |
Type | Choice of: Reference(ReferralRequest), Reference(CarePlan), Reference(DiagnosticRequest), Reference(ProcedureRequest) |
Requirements | To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT). |
ImagingStudy.referrer | |
Definition | The requesting/referring physician. |
Control | 0..1 |
Type | Reference(Practitioner) |
Alternate Names | ReferringPhysiciansName |
ImagingStudy.interpreter | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Control | 0..1 |
Type | Reference(Profile hspc-provpract) |
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual? |
ImagingStudy.baseLocation | |
Definition | Methods of accessing (e.g., retrieving, viewing) the study. |
Control | 0..* |
Type | BackboneElement |
Requirements | Access methods for viewing (e.g. IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type. |
ImagingStudy.baseLocation.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
ImagingStudy.baseLocation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.baseLocation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.baseLocation.type | |
Definition | The service type for accessing (e.g., retrieving, viewing) the DICOM instances. |
Control | 1..1 |
Binding | The type of the service endpoint The codes SHALL be taken from dWebType; other codes may be used where these codes are not suitable |
Type | Coding |
ImagingStudy.baseLocation.url | |
Definition | The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.baseLocation.type. |
Control | 1..1 |
Type | uri |
Comments | This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to view, retrieve, or otherwise access the study or the study’s series or instances. For example, this element may be a DICOMweb WADO-RS endpoint. |
ImagingStudy.numberOfSeries | |
Definition | Number of Series in Study. |
Control | 1..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedSeries |
ImagingStudy.numberOfInstances | |
Definition | Number of SOP Instances in Study. |
Control | 1..1 |
Type | unsignedInt |
Alternate Names | NumberOfStudyRelatedInstances |
ImagingStudy.procedure | |
Definition | Type of procedure performed. |
Control | 0..* |
Type | Reference(Procedure) |
Alternate Names | ProcedureCodeSequence |
Comments | For the Procedure.code, LOINC radiology orderables would be a good value set to use. |
ImagingStudy.reason | |
Definition | Description of clinical codition indicating why the ImagingStudy was requested. |
Control | 0..1 |
Binding | The reason for the study |
Type | CodeableConcept |
ImagingStudy.description | |
Definition | Institution-generated description or classification of the Study performed. |
Control | 0..1 |
Type | string |
Alternate Names | StudyDescription |
ImagingStudy.series | |
Definition | Each study has one or more series of images or other content. |
Control | 0..* |
Type | BackboneElement |
ImagingStudy.series.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
ImagingStudy.series.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.uid | |
Definition | Formal identifier for this series. |
Control | 1..1 |
Type | oid |
Alternate Names | SeriesInstanceUID |
Example | urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
ImagingStudy.series.number | |
Definition | The Numeric identifier of this series in the study. |
Control | 0..1 |
Type | unsignedInt |
Alternate Names | SeriesNumber |
Example | 3 |
ImagingStudy.series.modality | |
Definition | The modality of this series sequence. |
Control | 1..1 |
Binding | Type of acquired data in the instance The codes SHALL be taken from Acquisition Modality Codes; other codes may be used where these codes are not suitable |
Type | Coding |
Alternate Names | Modality |
ImagingStudy.series.description | |
Definition | A description of the series. |
Control | 0..1 |
Type | string |
Alternate Names | SeriesDescription |
Example | CT Surview 180 |
ImagingStudy.series.numberOfInstances | |
Definition | Number of SOP Instances in Series. |
Control | 1..1 |
Type | unsignedInt |
Alternate Names | NumberOfSeriesRelatedInstances |
ImagingStudy.series.availability | |
Definition | Availability of series (online, offline or nearline). |
Control | 0..1 |
Binding | Availability of the resource The codes SHALL be taken from InstanceAvailability |
Type | code |
Alternate Names | InstanceAvailability |
ImagingStudy.series.baseLocation | |
Definition | Methods of accessing (e.g. retrieving) the series. |
Control | 0..* |
Type | BackboneElement |
Requirements | Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level. |
ImagingStudy.series.baseLocation.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
ImagingStudy.series.baseLocation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.baseLocation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.baseLocation.type | |
Definition | The service type for accessing (e.g., retrieving) the DICOM instances. |
Control | 1..1 |
Binding | The type of the service endpoint The codes SHALL be taken from dWebType; other codes may be used where these codes are not suitable |
Type | Coding |
ImagingStudy.series.baseLocation.url | |
Definition | The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.series.baseLocation.type. |
Control | 1..1 |
Type | uri |
Comments | This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.series.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to retrieve, or otherwise access, the series or the series’ instances. For example, this element may be a DICOMweb WADO-RS endpoint. |
ImagingStudy.series.bodySite | |
Definition | Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT. |
Control | 0..1 |
Binding | Codes describing anatomical locations. May include laterality. For example codes, see SNOMED CT Body Structures |
Type | Coding |
Alternate Names | BodyPartExamined |
ImagingStudy.series.laterality | |
Definition | Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code. |
Control | 0..1 |
Binding | Codes describing body site laterality (left, right, etc.). For example codes, see Laterality |
Type | Coding |
ImagingStudy.series.started | |
Definition | The date and time the series was started. |
Control | 0..1 |
Type | dateTime |
ImagingStudy.series.instance | |
Definition | A single SOP Instance within the series, e.g. an image, or presentation state. |
Control | 0..* |
Type | BackboneElement |
ImagingStudy.series.instance.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
ImagingStudy.series.instance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.instance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ImagingStudy.series.instance.uid | |
Definition | Formal identifier for this image or other content. |
Control | 1..1 |
Type | oid |
Alternate Names | SOPInstanceUID |
Example | urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903 |
ImagingStudy.series.instance.number | |
Definition | The number of instance in the series. |
Control | 0..1 |
Type | unsignedInt |
Alternate Names | InstanceNumber |
Example | 1 |
ImagingStudy.series.instance.sopClass | |
Definition | DICOM instance type. |
Control | 1..1 |
Type | oid |
Alternate Names | SOPClassUID |
Example | urn:oid:1.2.840.10008.5.1.4.1.1.2 |
ImagingStudy.series.instance.title | |
Definition | The description of the instance. |
Control | 0..1 |
Type | string |
Comments | Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc. |