{
"description": "Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of images or other data objects (called Service-Object Pair Instances or SOP Instances) acquired or produced in a common context.",
"_filename": "StructureDefinition-ImagingStudy.json",
"package_name": "hl7.fhir.r6.core",
"date": "2025-12-18T07:07:42+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2025-12-18T07:07:42.170+11:00"
},
"publisher": "HL7 International / Imaging Integration",
"fhirVersion": "6.0.0-ballot4",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "ImagingStudy",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "https://dicomstandard.org/current",
"name": "DICOM Tag Mapping",
"identity": "dicom"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "ImagingStudy",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Clinical.Diagnostics"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "ii"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 6
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "patient"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "ist-1",
"human": "series SHALL only be present if an identifier is present with a system of urn:dicom:uid",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "series.exists() implies identifier.where(system = 'urn:dicom:uid').exists()"
}, {
"key": "ist-2",
"human": "At most, a single identifier SHALL be present with a system of urn:dicom:uid",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "identifier.where(system = 'urn:dicom:uid').count() < 2"
}, {
"key": "ist-3",
"human": "If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "numberOfSeries.exists() and series.exists() implies numberOfSeries = series.count()"
}, {
"key": "ist-4",
"human": "If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "numberOfInstances.exists() and series.exists() implies numberOfInstances = series.instance.count()"
}, {
"key": "ist-5",
"human": "If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values.",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "numberOfInstances.exists() and series.numberOfInstances.exists() implies numberOfInstances = series.numberOfInstances.aggregate($total + $this.toInteger(), 0)"
}, {
"key": "ist-6",
"human": "For each series element, if numberOfInstances and instance are both present, the numberOfInstances value SHALL match the number of instance elements",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "series.where(numberOfInstances.empty() or instance.empty() or numberOfInstances = instance.count()).count() = series.count()"
}, {
"key": "ist-7",
"human": "If modality is present, modality SHALL equal all of the distinct values of series.modality",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "modality.exists() implies modality.coding.select(system&'|'&code).trace('r').exclude(series.modality.coding.select(system&'|'&code).trace('c')).empty() and modality.text.exclude(series.modality.text).empty() and series.modality.coding.select(system&'|'&code).trace('r').exclude(modality.coding.select(system&'|'&code).trace('c')).empty() and series.modality.text.exclude(modality.text).empty()"
} ],
"path": "ImagingStudy",
"min": 0,
"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 can have multiple series of different modality values.",
"isModifier": false,
"short": "A set of images or image-related data produced in single study",
"mapping": [ {
"map": "Entity, Role, or Act,Act[classCode=COMPOSITION, moodCode=EVN]",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "clinical.diagnostics",
"identity": "w5"
}, {
"map": "DICOM Tag Mapping",
"identity": "dicom"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy"
},
"isSummary": false
}, {
"path": "ImagingStudy.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.implicitRules",
"min": 0,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.implicitRules",
"comment": "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "ImagingStudy.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can 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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ImagingStudy.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a 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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "ImagingStudy.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ImagingStudy.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImagingStudy.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImagingStudy.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.identifier",
"requirements": "Allows identification of the imaging study as it is known by various participating systems and in a way that remains consistent across servers. ImagingStudy.identifier SHALL include exactly one Study Instance UID value if one or more series element values are present (see [DICOM PS 3.3 C.7.2](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html).)",
"min": 0,
"definition": "Business identifiers assigned to this imaging study by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. Typically this will include the DICOM Study Instance UID.",
"isModifier": false,
"short": "Business identifier for imaging study",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id and .inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id",
"identity": "rim"
}, {
"map": "Study Instance UID (0020,000D) and / or Study ID (0020,0010)",
"identity": "dicom"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"alias": [ "StudyInstanceUID" ],
"max": "*",
"id": "ImagingStudy.identifier",
"condition": [ "ist-1", "ist-2" ],
"comment": "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices MAY occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number, or an accession number MAY be used to relate a Task, an ImagingStudy and a DiagnosticReport. See discussion under [Imaging Study Implementation Notes](imagingstudy.html#dicom-uids) for encoding of DICOM Study Instance UID.",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.status",
"min": 1,
"definition": "The current state of the imaging study. This is distinct from the status of any service request or task associated with the imaging study.",
"isModifier": true,
"short": "registered | available | cancelled | entered-in-error | unknown | inactive",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".status",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/imagingstudy-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingStudyStatus"
} ],
"description": "The status of the ImagingStudy."
},
"max": "1",
"id": "ImagingStudy.status",
"comment": "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.status"
},
"isModifierReason": "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource SHOULD NOT be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.modality",
"min": 0,
"definition": "All the distinct values of series.modality. This MAY be either an acquisition or a non-acquisition modality.",
"isModifier": false,
"short": "The distinct values for series' modalities",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "Modalities in Study (0008,0061) or Modality (0008,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
} ],
"description": "Type of acquired data in the instance."
},
"alias": [ "ModalitiesInStudy" ],
"max": "*",
"id": "ImagingStudy.modality",
"condition": [ "ist-7" ],
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.modality"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.subject",
"min": 1,
"definition": "The subject, typically a patient, of the imaging study.",
"isModifier": false,
"short": "Who or what is the subject of the study",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject",
"identity": "w5"
}, {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "Patient ID (0010,0020) and Issuer of Patient ID (0010,0021) and / or Issuer of Patient ID Qualifiers Sequence (0010,0024) and / or Patient Name (0010,0010)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.2.2.html"
} ],
"max": "1",
"id": "ImagingStudy.subject",
"comment": "QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.",
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.subject"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.encounter",
"min": 0,
"definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which the imaging data represented by this imaging study was acquired.",
"isModifier": false,
"short": "Encounter with which this imaging study is associated",
"mapping": [ {
"map": "Event.encounter",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.encounter",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.encounter"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.started",
"min": 0,
"definition": "Date and time the study started.",
"isModifier": false,
"short": "When the study was started",
"mapping": [ {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "Study Date (0008,0020) and Study Time (0008,0030)",
"identity": "dicom"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html#sect_C.7.2.1"
} ],
"alias": [ "StudyDate", "StudyTime" ],
"max": "1",
"id": "ImagingStudy.started",
"example": [ {
"label": "General",
"valueDateTime": "2011-01-01T11:01:20+03:00"
} ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.started"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.basedOn",
"requirements": "Allows tracing of authorization for the imaging study and tracking whether proposals/recommendations were acted upon. If the ImagingStudy is associated with an Accession Number, this field SHOULD include a reference to that value in the form: identifier.value = (Accession Number Value) identifier.type = ACSN. A reference value pointing to a ServiceRequest resource is allowed but is not required.",
"min": 0,
"definition": "A plan or order that is fulfilled in whole or in part by this imaging study.",
"isModifier": false,
"short": "Fulfills plan or order",
"mapping": [ {
"map": "Event.basedOn",
"identity": "workflow"
}, {
"map": "FiveWs.cause",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]",
"identity": "rim"
}, {
"map": "Accession Number (0080,0050) and Issuer of Accession Number Sequence (0080,0051) and / or Requested Procedure Code Sequence (0032,1064)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/Appointment", "http://hl7.org/fhir/StructureDefinition/Task" ]
} ],
"mustSupport": false,
"alias": [ "AccessionNumber" ],
"max": "*",
"id": "ImagingStudy.basedOn",
"comment": "One imaging study MAY be based on multiple ordered procedures, e.g. chest/abdomen/pelvis CT orders being fulfilled by a single imaging study.",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.basedOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.procedure",
"min": 0,
"definition": "The performed procedure(s) during which the data associated with this imaging study was created.",
"isModifier": false,
"short": "Imaging performed procedure(s)",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
}, {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Procedure" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.procedure",
"comment": "To link an imaging study to an Encounter use `encounter`.",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.procedure"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.referrer",
"min": 0,
"definition": "The referring physician.",
"isModifier": false,
"short": "Referring physician",
"mapping": [ {
"map": "FiveWs.cause",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role",
"identity": "rim"
}, {
"map": "Referring Physician's Name (0008,0090) and Referring Physician Identification Sequence (0008,0096)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"alias": [ "ReferringPhysiciansName" ],
"max": "1",
"id": "ImagingStudy.referrer",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.referrer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.endpoint",
"requirements": "Access methods for viewing or retrieving 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.",
"min": 0,
"definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.",
"isModifier": false,
"short": "Study access endpoint",
"mapping": [ {
"map": "Not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.endpoint",
"comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM metadata without retrieving the actual instances. See [Imaging Study Implementation Notes on Endpoints](imagingstudy.html#endpoints).",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.endpoint"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.location",
"requirements": "Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).",
"min": 0,
"definition": "The principal physical location where the imaging study was performed.",
"isModifier": false,
"short": "Where imaging study occurred",
"mapping": [ {
"map": "Event.location",
"identity": "workflow"
}, {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": "EVN-7",
"identity": "v2"
}, {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
}, {
"map": "Institutional Department Name (0008,1040) and Institutional Department Type Code Sequence (0008,1041)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.location",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.location"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.reason",
"min": 0,
"definition": "Describes why the imaging study occurred in coded or textual form or indicates another resource whose existence justifies this imaging study.",
"isModifier": false,
"short": " Why was imaging study performed?",
"mapping": [ {
"map": "Event.reason",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".reasonCode",
"identity": "rim"
}, {
"map": "Reason for Requested Procedure Code Sequence (0040,1002)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/procedure-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingReason"
} ],
"description": "The reason for the study."
},
"max": "*",
"id": "ImagingStudy.reason",
"comment": "This MAY correspond to the indications or reasons encoded in an associated service request.",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.reason"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.note",
"min": 0,
"definition": "Comments made about the imaging study by the performer, subject or other participants.",
"isModifier": false,
"short": "Comments made about the imaging study",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
} ],
"type": [ {
"code": "Annotation"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.note",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.note"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.description",
"min": 0,
"definition": "Description or classification of the imaging study.",
"isModifier": false,
"short": "Study Description or Classification",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": "Study Description (0008,1030)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"alias": [ "StudyDescription" ],
"max": "1",
"id": "ImagingStudy.description",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.numberOfSeries",
"min": 0,
"definition": "Number of known Series in the Study. This value might be present even if the ImagingStudy.series element is empty or only partially populated.",
"isModifier": false,
"short": "Number of Study Related Series",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "Number of Study Related Series (0020,1206). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "NumberOfStudyRelatedSeries" ],
"max": "1",
"id": "ImagingStudy.numberOfSeries",
"condition": [ "ist-3" ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.numberOfSeries"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.numberOfInstances",
"min": 0,
"definition": "Number of known SOP Instances in Study. This value might be present even if the ImagingStudy.series.instance elements are empty or only partially populated.",
"isModifier": false,
"short": "Number of Study Related Instances",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "Number of Study Related Instances (0020,1208). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "NumberOfStudyRelatedInstances" ],
"max": "1",
"id": "ImagingStudy.numberOfInstances",
"condition": [ "ist-4", "ist-5" ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.numberOfInstances"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series",
"min": 0,
"definition": "The set of Series belonging to the study. Each Series contains a set of SOP Instances, which could be images, waveforms, or other content.",
"isModifier": false,
"short": "The set of Series belonging to the study",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series",
"condition": [ "ist-1", "ist-3", "ist-4", "ist-5", "ist-6", "ist-7" ],
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.series"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImagingStudy.series.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImagingStudy.series.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImagingStudy.series.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.uid",
"requirements": "DICOM Series Instance UID.",
"min": 1,
"definition": "The DICOM Series Instance UID of the series.",
"isModifier": false,
"short": "DICOM Series Instance UID",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "Series Instance UID (0020,000E)",
"identity": "dicom"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"alias": [ "SeriesInstanceUID" ],
"max": "1",
"id": "ImagingStudy.series.uid",
"comment": "See [DICOM PS3.3 C.7.3](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html).",
"example": [ {
"label": "General",
"valueId": "2.16.124.113543.6003.2588828330.45298.17418.2723805630"
} ],
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.uid"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.number",
"min": 0,
"definition": "The numeric identifier of this series in the study.",
"isModifier": false,
"short": "Numeric identifier of this series",
"mapping": [ {
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber",
"identity": "rim"
}, {
"map": "Series Number (0020,0011)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "SeriesNumber" ],
"max": "1",
"id": "ImagingStudy.series.number",
"example": [ {
"label": "General",
"valueUnsignedInt": 3
} ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.number"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.modality",
"min": 1,
"definition": "The distinct modality for this series. This MAY be either an acquisition modality (e.g., CT, MR) or a non-acquisition modality (e.g., segmentation, presentation state).",
"isModifier": false,
"short": "The modality used for this series",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "Modality (0008,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
} ],
"description": "Type of acquired data in the instance."
},
"alias": [ "Modality" ],
"max": "1",
"id": "ImagingStudy.series.modality",
"condition": [ "ist-7" ],
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.modality"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.description",
"min": 0,
"definition": "Description or classification of the series.",
"isModifier": false,
"short": "Series Description or Classification",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": "Series Description (0008,103E)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"alias": [ "SeriesDescription" ],
"max": "1",
"id": "ImagingStudy.series.description",
"example": [ {
"label": "General",
"valueString": "CT Surview 180"
} ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.numberOfInstances",
"min": 0,
"definition": "Number of SOP Instances in the Series. The value given MAY be larger than the number of instance elements this series contains due to resource availability, security, or other factors. This element SHOULD be present if any instance elements are present.",
"isModifier": false,
"short": "Number of Series Related Instances",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "Number of Series Related Instances (0020,1209). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "NumberOfSeriesRelatedInstances" ],
"max": "1",
"id": "ImagingStudy.series.numberOfInstances",
"condition": [ "ist-5", "ist-6" ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.numberOfInstances"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.endpoint",
"min": 0,
"definition": "The network service providing access for the study. See implementation notes for information about [using DICOM endpoints](imagingstudy.html#endpoints).",
"isModifier": false,
"short": "Series access endpoint",
"mapping": [ {
"map": "Not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series.endpoint",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.series.endpoint"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.bodySite",
"min": 0,
"definition": "The anatomic structures examined. See [DICOM Part 16 Annex L](http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite MAY include the laterality of body part imaged.",
"isModifier": false,
"short": "Body part examined",
"mapping": [ {
"map": ".targetSiteCode",
"identity": "rim"
}, {
"map": "Body Part Examined (0018,0015) or Anatomic Region Sequence (0008,2218) and Laterality (0020,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/BodyStructure" ]
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/body-site",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes describing anatomical locations. MAY include laterality."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "SNOMED CT Body site concepts"
},
"alias": [ "BodyPartExamined" ],
"max": "1",
"id": "ImagingStudy.series.bodySite",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.bodySite"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.specimen",
"min": 0,
"definition": "The specimen imaged, e.g., for whole slide imaging of a biopsy.",
"isModifier": false,
"short": "Specimen imaged",
"mapping": [ {
"map": "Role[classCode=SPEC]",
"identity": "rim"
}, {
"map": "Specimen Identifier (0040,0551) or Specimen UID (0040,0554) and + Issuer of the Specimen Identifier Sequence (0040,0562)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series.specimen",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.series.specimen"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.started",
"min": 0,
"definition": "The date and time the series was started.",
"isModifier": false,
"short": "When the series started",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "Series Date (0008,0021) + and Series Time (0008,0031)",
"identity": "dicom"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.series.started",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.started"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.performer",
"requirements": "The performer is recorded at the series level, since each series in a study MAY be performed by a different performer, at different times, and using different devices. A series MAY be performed by multiple performers.",
"min": 0,
"definition": "Indicates who or what performed the series and how they were involved.",
"isModifier": false,
"short": "Who performed the series",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": ".participation[typeCode=PRF].role",
"identity": "rim"
}, {
"map": "One or more of: Performing Physician's Name (0008,1050) and Performing Physician Identification Sequence (0008,1052); Operators' Name (0008,1070) and Operator Identification Sequence (0008,1072); Manufacturer (0008,0070) and Manufacturer's Model Name (0008,1090); or Institution Name (0008,0080)",
"identity": "dicom"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"alias": [ "PerformingPhysicianName", "OperatorName", "ManufacturersModelName", "InstitutionName" ],
"max": "*",
"id": "ImagingStudy.series.performer",
"comment": "If the person who performed the series is not known, their Organization MAY be recorded. A patient, or related person, MAY be the performer, e.g. for patient-captured images.",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.series.performer"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.performer.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImagingStudy.series.performer.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.performer.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImagingStudy.series.performer.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.performer.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImagingStudy.series.performer.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.performer.function",
"requirements": "Allows disambiguation of the types of involvement of different performers.",
"min": 0,
"definition": "Distinguishes the type of involvement of the performer in the imaging study..",
"isModifier": false,
"short": "Type of performance",
"mapping": [ {
"map": "Event.performer.function",
"identity": "workflow"
}, {
"map": ".participation[typeCode=PRF].role",
"identity": "rim"
}, {
"map": "PRF (Performing Physician's Name); SPRF (Operator's Name); DEV (Manufacturer / Manufacturer's Model Name); or LOC (Institution Name)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/series-performer-function",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventPerformerFunction"
} ],
"description": "The type of involvement of the performer."
},
"max": "1",
"id": "ImagingStudy.series.performer.function",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.performer.function"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.performer.actor",
"min": 1,
"definition": "Indicates who or what performed the imaging study.",
"isModifier": false,
"short": "Who performed imaging study",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "EVN-5 or by domain",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
}, {
"map": "Practitioner (Performing Physician's Name); Practitioner (Operator's Name); Device (Manufacturer / Manufacturer's Model Name); or Organization (Institution Name)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.series.performer.actor",
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.performer.actor"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.instance",
"min": 0,
"definition": "A single SOP instance within the series, e.g. an image, or presentation state.",
"isModifier": false,
"short": "A single SOP instance from the series",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series.instance",
"condition": [ "ist-4", "ist-6" ],
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.series.instance"
},
"isSummary": false
}, {
"path": "ImagingStudy.series.instance.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImagingStudy.series.instance.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.instance.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImagingStudy.series.instance.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.instance.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImagingStudy.series.instance.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.instance.uid",
"requirements": "DICOM SOP Instance UID.",
"min": 1,
"definition": "The DICOM SOP Instance UID for this image or other DICOM content.",
"isModifier": false,
"short": "DICOM SOP Instance UID",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "SOP Instance UID (0008,0018)",
"identity": "dicom"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"alias": [ "SOPInstanceUID" ],
"max": "1",
"id": "ImagingStudy.series.instance.uid",
"comment": "See [DICOM PS3.3 C.12.1](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.12.html#sect_C.12.1).",
"example": [ {
"label": "General",
"valueId": "2.16.124.113543.6003.189642796.63084.16748.2599092903"
} ],
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.instance.uid"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.instance.sopClass",
"min": 1,
"definition": "DICOM instance type.",
"isModifier": false,
"short": "DICOM class type",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value",
"identity": "rim"
}, {
"map": "SOP Class UID (0008,0016)",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"mustSupport": false,
"alias": [ "SOPClassUID" ],
"max": "1",
"id": "ImagingStudy.series.instance.sopClass",
"comment": "Typically a well-known DICOM SOP Class UID but MAY be the UID of a private SOP Class",
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.instance.sopClass"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.instance.number",
"min": 0,
"definition": "The number of the instance assigned by the creator of the series. MAY or MAY NOT correspond to intended display order.",
"isModifier": false,
"short": "The number of this instance in the series",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber",
"identity": "rim"
}, {
"map": "Instance Number (0020,0013)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "InstanceNumber" ],
"max": "1",
"id": "ImagingStudy.series.instance.number",
"example": [ {
"label": "General",
"valueUnsignedInt": 1
} ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.instance.number"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImagingStudy.series.instance.title",
"min": 0,
"definition": "The title of the instance.",
"isModifier": false,
"short": "Name or title of the instance",
"mapping": [ {
"map": ".title",
"identity": "rim"
}, {
"map": "Document Title (0042,0010)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.series.instance.title",
"comment": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.instance.title"
},
"isSummary": false
} ]
},
"status": "active",
"id": "752b08cb-35d1-44d5-b881-0e5cf76f281d",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"version": "6.0.0-ballot4",
"differential": {
"element": [ {
"constraint": [ {
"key": "ist-2",
"human": "At most, a single identifier SHALL be present with a system of urn:dicom:uid",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "identifier.where(system = 'urn:dicom:uid').count() < 2"
}, {
"key": "ist-1",
"human": "series SHALL only be present if an identifier is present with a system of urn:dicom:uid",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "series.exists() implies identifier.where(system = 'urn:dicom:uid').exists()"
}, {
"key": "ist-7",
"human": "If modality is present, modality SHALL equal all of the distinct values of series.modality",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "modality.exists() implies modality.coding.select(system&'|'&code).trace('r').exclude(series.modality.coding.select(system&'|'&code).trace('c')).empty() and modality.text.exclude(series.modality.text).empty() and series.modality.coding.select(system&'|'&code).trace('r').exclude(modality.coding.select(system&'|'&code).trace('c')).empty() and series.modality.text.exclude(modality.text).empty()"
}, {
"key": "ist-4",
"human": "If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "numberOfInstances.exists() and series.exists() implies numberOfInstances = series.instance.count()"
}, {
"key": "ist-3",
"human": "If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "numberOfSeries.exists() and series.exists() implies numberOfSeries = series.count()"
}, {
"key": "ist-6",
"human": "For each series element, if numberOfInstances and instance are both present, the numberOfInstances value SHALL match the number of instance elements",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "series.where(numberOfInstances.empty() or instance.empty() or numberOfInstances = instance.count()).count() = series.count()"
}, {
"key": "ist-5",
"human": "If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values.",
"source": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"severity": "error",
"expression": "numberOfInstances.exists() and series.numberOfInstances.exists() implies numberOfInstances = series.numberOfInstances.aggregate($total + $this.toInteger(), 0)"
} ],
"path": "ImagingStudy",
"min": 0,
"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 can have multiple series of different modality values.",
"isModifier": false,
"short": "A set of images or image-related data produced in single study",
"mapping": [ {
"map": "Event",
"identity": "workflow"
}, {
"map": "clinical.diagnostics",
"identity": "w5"
}, {
"map": "Act[classCode=COMPOSITION, moodCode=EVN]",
"identity": "rim"
}, {
"map": "DICOM Tag Mapping",
"identity": "dicom"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy"
}, {
"path": "ImagingStudy.identifier",
"requirements": "Allows identification of the imaging study as it is known by various participating systems and in a way that remains consistent across servers. ImagingStudy.identifier SHALL include exactly one Study Instance UID value if one or more series element values are present (see [DICOM PS 3.3 C.7.2](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html).)",
"min": 0,
"definition": "Business identifiers assigned to this imaging study by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. Typically this will include the DICOM Study Instance UID.",
"isModifier": false,
"short": "Business identifier for imaging study",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id and .inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id",
"identity": "rim"
}, {
"map": "Study Instance UID (0020,000D) and / or Study ID (0020,0010)",
"identity": "dicom"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"alias": [ "StudyInstanceUID" ],
"max": "*",
"id": "ImagingStudy.identifier",
"condition": [ "ist-1", "ist-2" ],
"comment": "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices MAY occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number, or an accession number MAY be used to relate a Task, an ImagingStudy and a DiagnosticReport. See discussion under [Imaging Study Implementation Notes](imagingstudy.html#dicom-uids) for encoding of DICOM Study Instance UID.",
"isSummary": true
}, {
"path": "ImagingStudy.status",
"min": 1,
"definition": "The current state of the imaging study. This is distinct from the status of any service request or task associated with the imaging study.",
"isModifier": true,
"short": "registered | available | cancelled | entered-in-error | unknown | inactive",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".status",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/imagingstudy-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingStudyStatus"
} ],
"description": "The status of the ImagingStudy."
},
"max": "1",
"id": "ImagingStudy.status",
"comment": "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"isModifierReason": "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource SHOULD NOT be treated as valid",
"isSummary": true
}, {
"path": "ImagingStudy.modality",
"min": 0,
"definition": "All the distinct values of series.modality. This MAY be either an acquisition or a non-acquisition modality.",
"isModifier": false,
"short": "The distinct values for series' modalities",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "Modalities in Study (0008,0061) or Modality (0008,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
} ],
"description": "Type of acquired data in the instance."
},
"alias": [ "ModalitiesInStudy" ],
"max": "*",
"id": "ImagingStudy.modality",
"condition": [ "ist-7" ],
"isSummary": true
}, {
"path": "ImagingStudy.subject",
"min": 1,
"definition": "The subject, typically a patient, of the imaging study.",
"isModifier": false,
"short": "Who or what is the subject of the study",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject",
"identity": "w5"
}, {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "Patient ID (0010,0020) and Issuer of Patient ID (0010,0021) and / or Issuer of Patient ID Qualifiers Sequence (0010,0024) and / or Patient Name (0010,0010)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.2.2.html"
} ],
"max": "1",
"id": "ImagingStudy.subject",
"comment": "QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.",
"isSummary": true
}, {
"path": "ImagingStudy.encounter",
"min": 0,
"definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which the imaging data represented by this imaging study was acquired.",
"isModifier": false,
"short": "Encounter with which this imaging study is associated",
"mapping": [ {
"map": "Event.encounter",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.encounter",
"isSummary": true
}, {
"path": "ImagingStudy.started",
"min": 0,
"definition": "Date and time the study started.",
"isModifier": false,
"short": "When the study was started",
"mapping": [ {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "Study Date (0008,0020) and Study Time (0008,0030)",
"identity": "dicom"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html#sect_C.7.2.1"
} ],
"alias": [ "StudyDate", "StudyTime" ],
"max": "1",
"id": "ImagingStudy.started",
"example": [ {
"label": "General",
"valueDateTime": "2011-01-01T11:01:20+03:00"
} ],
"isSummary": true
}, {
"path": "ImagingStudy.basedOn",
"requirements": "Allows tracing of authorization for the imaging study and tracking whether proposals/recommendations were acted upon. If the ImagingStudy is associated with an Accession Number, this field SHOULD include a reference to that value in the form: identifier.value = (Accession Number Value) identifier.type = ACSN. A reference value pointing to a ServiceRequest resource is allowed but is not required.",
"min": 0,
"definition": "A plan or order that is fulfilled in whole or in part by this imaging study.",
"isModifier": false,
"short": "Fulfills plan or order",
"mapping": [ {
"map": "Event.basedOn",
"identity": "workflow"
}, {
"map": "FiveWs.cause",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]",
"identity": "rim"
}, {
"map": "Accession Number (0080,0050) and Issuer of Accession Number Sequence (0080,0051) and / or Requested Procedure Code Sequence (0032,1064)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/Appointment", "http://hl7.org/fhir/StructureDefinition/Task" ]
} ],
"mustSupport": false,
"alias": [ "AccessionNumber" ],
"max": "*",
"id": "ImagingStudy.basedOn",
"comment": "One imaging study MAY be based on multiple ordered procedures, e.g. chest/abdomen/pelvis CT orders being fulfilled by a single imaging study.",
"isSummary": true
}, {
"path": "ImagingStudy.procedure",
"min": 0,
"definition": "The performed procedure(s) during which the data associated with this imaging study was created.",
"isModifier": false,
"short": "Imaging performed procedure(s)",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
}, {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Procedure" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.procedure",
"comment": "To link an imaging study to an Encounter use `encounter`.",
"isSummary": true
}, {
"path": "ImagingStudy.referrer",
"min": 0,
"definition": "The referring physician.",
"isModifier": false,
"short": "Referring physician",
"mapping": [ {
"map": "FiveWs.cause",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role",
"identity": "rim"
}, {
"map": "Referring Physician's Name (0008,0090) and Referring Physician Identification Sequence (0008,0096)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"alias": [ "ReferringPhysiciansName" ],
"max": "1",
"id": "ImagingStudy.referrer",
"isSummary": true
}, {
"path": "ImagingStudy.endpoint",
"requirements": "Access methods for viewing or retrieving 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.",
"min": 0,
"definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.",
"isModifier": false,
"short": "Study access endpoint",
"mapping": [ {
"map": "Not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.endpoint",
"comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM metadata without retrieving the actual instances. See [Imaging Study Implementation Notes on Endpoints](imagingstudy.html#endpoints).",
"isSummary": true
}, {
"path": "ImagingStudy.location",
"requirements": "Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).",
"min": 0,
"definition": "The principal physical location where the imaging study was performed.",
"isModifier": false,
"short": "Where imaging study occurred",
"mapping": [ {
"map": "Event.location",
"identity": "workflow"
}, {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": "EVN-7",
"identity": "v2"
}, {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
}, {
"map": "Institutional Department Name (0008,1040) and Institutional Department Type Code Sequence (0008,1041)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.location",
"isSummary": true
}, {
"path": "ImagingStudy.reason",
"min": 0,
"definition": "Describes why the imaging study occurred in coded or textual form or indicates another resource whose existence justifies this imaging study.",
"isModifier": false,
"short": " Why was imaging study performed?",
"mapping": [ {
"map": "Event.reason",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".reasonCode",
"identity": "rim"
}, {
"map": "Reason for Requested Procedure Code Sequence (0040,1002)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/procedure-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingReason"
} ],
"description": "The reason for the study."
},
"max": "*",
"id": "ImagingStudy.reason",
"comment": "This MAY correspond to the indications or reasons encoded in an associated service request.",
"isSummary": true
}, {
"path": "ImagingStudy.note",
"min": 0,
"definition": "Comments made about the imaging study by the performer, subject or other participants.",
"isModifier": false,
"short": "Comments made about the imaging study",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
} ],
"type": [ {
"code": "Annotation"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.note",
"isSummary": true
}, {
"path": "ImagingStudy.description",
"min": 0,
"definition": "Description or classification of the imaging study.",
"isModifier": false,
"short": "Study Description or Classification",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": "Study Description (0008,1030)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"alias": [ "StudyDescription" ],
"max": "1",
"id": "ImagingStudy.description",
"isSummary": true
}, {
"path": "ImagingStudy.numberOfSeries",
"min": 0,
"definition": "Number of known Series in the Study. This value might be present even if the ImagingStudy.series element is empty or only partially populated.",
"isModifier": false,
"short": "Number of Study Related Series",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "Number of Study Related Series (0020,1206). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "NumberOfStudyRelatedSeries" ],
"max": "1",
"id": "ImagingStudy.numberOfSeries",
"condition": [ "ist-3" ],
"isSummary": true
}, {
"path": "ImagingStudy.numberOfInstances",
"min": 0,
"definition": "Number of known SOP Instances in Study. This value might be present even if the ImagingStudy.series.instance elements are empty or only partially populated.",
"isModifier": false,
"short": "Number of Study Related Instances",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "Number of Study Related Instances (0020,1208). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "NumberOfStudyRelatedInstances" ],
"max": "1",
"id": "ImagingStudy.numberOfInstances",
"condition": [ "ist-4", "ist-5" ],
"isSummary": true
}, {
"path": "ImagingStudy.series",
"min": 0,
"definition": "The set of Series belonging to the study. Each Series contains a set of SOP Instances, which could be images, waveforms, or other content.",
"isModifier": false,
"short": "The set of Series belonging to the study",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series",
"condition": [ "ist-1", "ist-3", "ist-4", "ist-5", "ist-6", "ist-7" ],
"isSummary": true
}, {
"path": "ImagingStudy.series.uid",
"requirements": "DICOM Series Instance UID.",
"min": 1,
"definition": "The DICOM Series Instance UID of the series.",
"isModifier": false,
"short": "DICOM Series Instance UID",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "Series Instance UID (0020,000E)",
"identity": "dicom"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"alias": [ "SeriesInstanceUID" ],
"max": "1",
"id": "ImagingStudy.series.uid",
"comment": "See [DICOM PS3.3 C.7.3](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html).",
"example": [ {
"label": "General",
"valueId": "2.16.124.113543.6003.2588828330.45298.17418.2723805630"
} ],
"isSummary": true
}, {
"path": "ImagingStudy.series.number",
"min": 0,
"definition": "The numeric identifier of this series in the study.",
"isModifier": false,
"short": "Numeric identifier of this series",
"mapping": [ {
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber",
"identity": "rim"
}, {
"map": "Series Number (0020,0011)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "SeriesNumber" ],
"max": "1",
"id": "ImagingStudy.series.number",
"example": [ {
"label": "General",
"valueUnsignedInt": 3
} ],
"isSummary": true
}, {
"path": "ImagingStudy.series.modality",
"min": 1,
"definition": "The distinct modality for this series. This MAY be either an acquisition modality (e.g., CT, MR) or a non-acquisition modality (e.g., segmentation, presentation state).",
"isModifier": false,
"short": "The modality used for this series",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "Modality (0008,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
} ],
"description": "Type of acquired data in the instance."
},
"alias": [ "Modality" ],
"max": "1",
"id": "ImagingStudy.series.modality",
"condition": [ "ist-7" ],
"isSummary": true
}, {
"path": "ImagingStudy.series.description",
"min": 0,
"definition": "Description or classification of the series.",
"isModifier": false,
"short": "Series Description or Classification",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": "Series Description (0008,103E)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"alias": [ "SeriesDescription" ],
"max": "1",
"id": "ImagingStudy.series.description",
"example": [ {
"label": "General",
"valueString": "CT Surview 180"
} ],
"isSummary": true
}, {
"path": "ImagingStudy.series.numberOfInstances",
"min": 0,
"definition": "Number of SOP Instances in the Series. The value given MAY be larger than the number of instance elements this series contains due to resource availability, security, or other factors. This element SHOULD be present if any instance elements are present.",
"isModifier": false,
"short": "Number of Series Related Instances",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "Number of Series Related Instances (0020,1209). Note: this attribute is not included in DICOM instance metadata but is returned as a result of a query.",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "NumberOfSeriesRelatedInstances" ],
"max": "1",
"id": "ImagingStudy.series.numberOfInstances",
"condition": [ "ist-5", "ist-6" ],
"isSummary": true
}, {
"path": "ImagingStudy.series.endpoint",
"min": 0,
"definition": "The network service providing access for the study. See implementation notes for information about [using DICOM endpoints](imagingstudy.html#endpoints).",
"isModifier": false,
"short": "Series access endpoint",
"mapping": [ {
"map": "Not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series.endpoint",
"isSummary": true
}, {
"path": "ImagingStudy.series.bodySite",
"min": 0,
"definition": "The anatomic structures examined. See [DICOM Part 16 Annex L](http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite MAY include the laterality of body part imaged.",
"isModifier": false,
"short": "Body part examined",
"mapping": [ {
"map": ".targetSiteCode",
"identity": "rim"
}, {
"map": "Body Part Examined (0018,0015) or Anatomic Region Sequence (0008,2218) and Laterality (0020,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/BodyStructure" ]
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/body-site",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes describing anatomical locations. MAY include laterality."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "SNOMED CT Body site concepts"
},
"alias": [ "BodyPartExamined" ],
"max": "1",
"id": "ImagingStudy.series.bodySite",
"isSummary": true
}, {
"path": "ImagingStudy.series.specimen",
"min": 0,
"definition": "The specimen imaged, e.g., for whole slide imaging of a biopsy.",
"isModifier": false,
"short": "Specimen imaged",
"mapping": [ {
"map": "Role[classCode=SPEC]",
"identity": "rim"
}, {
"map": "Specimen Identifier (0040,0551) or Specimen UID (0040,0554) and + Issuer of the Specimen Identifier Sequence (0040,0562)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series.specimen",
"isSummary": true
}, {
"path": "ImagingStudy.series.started",
"min": 0,
"definition": "The date and time the series was started.",
"isModifier": false,
"short": "When the series started",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "Series Date (0008,0021) + and Series Time (0008,0031)",
"identity": "dicom"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.series.started",
"isSummary": true
}, {
"path": "ImagingStudy.series.performer",
"requirements": "The performer is recorded at the series level, since each series in a study MAY be performed by a different performer, at different times, and using different devices. A series MAY be performed by multiple performers.",
"min": 0,
"definition": "Indicates who or what performed the series and how they were involved.",
"isModifier": false,
"short": "Who performed the series",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": ".participation[typeCode=PRF].role",
"identity": "rim"
}, {
"map": "One or more of: Performing Physician's Name (0008,1050) and Performing Physician Identification Sequence (0008,1052); Operators' Name (0008,1070) and Operator Identification Sequence (0008,1072); Manufacturer (0008,0070) and Manufacturer's Model Name (0008,1090); or Institution Name (0008,0080)",
"identity": "dicom"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"alias": [ "PerformingPhysicianName", "OperatorName", "ManufacturersModelName", "InstitutionName" ],
"max": "*",
"id": "ImagingStudy.series.performer",
"comment": "If the person who performed the series is not known, their Organization MAY be recorded. A patient, or related person, MAY be the performer, e.g. for patient-captured images.",
"isSummary": true
}, {
"path": "ImagingStudy.series.performer.function",
"requirements": "Allows disambiguation of the types of involvement of different performers.",
"min": 0,
"definition": "Distinguishes the type of involvement of the performer in the imaging study..",
"isModifier": false,
"short": "Type of performance",
"mapping": [ {
"map": "Event.performer.function",
"identity": "workflow"
}, {
"map": ".participation[typeCode=PRF].role",
"identity": "rim"
}, {
"map": "PRF (Performing Physician's Name); SPRF (Operator's Name); DEV (Manufacturer / Manufacturer's Model Name); or LOC (Institution Name)",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/series-performer-function",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventPerformerFunction"
} ],
"description": "The type of involvement of the performer."
},
"max": "1",
"id": "ImagingStudy.series.performer.function",
"isSummary": true
}, {
"path": "ImagingStudy.series.performer.actor",
"min": 1,
"definition": "Indicates who or what performed the imaging study.",
"isModifier": false,
"short": "Who performed imaging study",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "EVN-5 or by domain",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
}, {
"map": "Practitioner (Performing Physician's Name); Practitioner (Operator's Name); Device (Manufacturer / Manufacturer's Model Name); or Organization (Institution Name)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.series.performer.actor",
"isSummary": true
}, {
"path": "ImagingStudy.series.instance",
"min": 0,
"definition": "A single SOP instance within the series, e.g. an image, or presentation state.",
"isModifier": false,
"short": "A single SOP instance from the series",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy.series.instance",
"condition": [ "ist-4", "ist-6" ],
"isSummary": false
}, {
"path": "ImagingStudy.series.instance.uid",
"requirements": "DICOM SOP Instance UID.",
"min": 1,
"definition": "The DICOM SOP Instance UID for this image or other DICOM content.",
"isModifier": false,
"short": "DICOM SOP Instance UID",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "SOP Instance UID (0008,0018)",
"identity": "dicom"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"alias": [ "SOPInstanceUID" ],
"max": "1",
"id": "ImagingStudy.series.instance.uid",
"comment": "See [DICOM PS3.3 C.12.1](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.12.html#sect_C.12.1).",
"example": [ {
"label": "General",
"valueId": "2.16.124.113543.6003.189642796.63084.16748.2599092903"
} ],
"isSummary": false
}, {
"path": "ImagingStudy.series.instance.sopClass",
"min": 1,
"definition": "DICOM instance type.",
"isModifier": false,
"short": "DICOM class type",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value",
"identity": "rim"
}, {
"map": "SOP Class UID (0008,0016)",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"mustSupport": false,
"alias": [ "SOPClassUID" ],
"max": "1",
"id": "ImagingStudy.series.instance.sopClass",
"comment": "Typically a well-known DICOM SOP Class UID but MAY be the UID of a private SOP Class",
"isSummary": false
}, {
"path": "ImagingStudy.series.instance.number",
"min": 0,
"definition": "The number of the instance assigned by the creator of the series. MAY or MAY NOT correspond to intended display order.",
"isModifier": false,
"short": "The number of this instance in the series",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber",
"identity": "rim"
}, {
"map": "Instance Number (0020,0013)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"mustSupport": false,
"alias": [ "InstanceNumber" ],
"max": "1",
"id": "ImagingStudy.series.instance.number",
"example": [ {
"label": "General",
"valueUnsignedInt": 1
} ],
"isSummary": false
}, {
"path": "ImagingStudy.series.instance.title",
"min": 0,
"definition": "The title of the instance.",
"isModifier": false,
"short": "Name or title of the instance",
"mapping": [ {
"map": ".title",
"identity": "rim"
}, {
"map": "Document Title (0042,0010)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImagingStudy.series.instance.title",
"comment": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/imagemgt",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}