{
"description": "Profile of ImagingStudy for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.",
"_filename": "StructureDefinition-qicore-imagingstudy.json",
"package_name": "hl7.fhir.us.qicore",
"date": "2018-08-22T00:00:00+10:00",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - CQI WG",
"fhirVersion": "3.0.1",
"name": "QICore-ImagingStudy",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://nema.org/dicom",
"name": "DICOM Tag Mapping",
"identity": "dicom"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "ImagingStudy",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "3.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).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 may have multiple series of different modalities.",
"short": "A set of images produced in single study (one or more series of references images)",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Act[classCode=COMPOSITION, moodCode=EVN]",
"identity": "rim"
}, {
"map": "Reference IHE radiology TF vol 2 table 4.14-1",
"identity": "dicom"
}, {
"map": "clinical.diagnostics",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "ImagingStudy",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy"
}
}, {
"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.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "ImagingStudy.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "ImagingStudy.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "ImagingStudy.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "ImagingStudy.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"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"
}
}, {
"path": "ImagingStudy.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ImagingStudy.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"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, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ImagingStudy.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "ImagingStudy.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "ImagingStudy.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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "ImagingStudy.uid",
"min": 1,
"definition": "Formal identifier for the study.",
"short": "Formal DICOM identifier for the study",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "(0020,000D)",
"identity": "dicom"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "oid"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "dicom="
} ],
"alias": [ "StudyInstanceUID" ],
"max": "1",
"id": "ImagingStudy.uid",
"example": [ {
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
} ],
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.uid"
},
"isSummary": true
}, {
"path": "ImagingStudy.accession",
"min": 0,
"definition": "Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).",
"short": "Related workflow identifier (\"Accession Number\")",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id",
"identity": "rim"
}, {
"map": "(0008,0050)",
"identity": "dicom"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"alias": [ "AccessionNumber" ],
"max": "1",
"id": "ImagingStudy.accession",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.accession"
},
"isSummary": true
}, {
"path": "ImagingStudy.identifier",
"min": 0,
"definition": "Other identifiers for the study.",
"short": "Other identifiers for the study",
"mapping": [ {
"map": ".id (no means to distinguish from uid)",
"identity": "rim"
}, {
"map": "(0020,0010)",
"identity": "dicom"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"alias": [ "StudyID" ],
"max": "*",
"id": "ImagingStudy.identifier",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.identifier"
},
"isSummary": true
}, {
"path": "ImagingStudy.availability",
"min": 0,
"definition": "Availability of study (online, offline, or nearline).",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"mapping": [ {
"map": "Not supported",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InstanceAvailability"
} ],
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"alias": [ "InstanceAvailability" ],
"max": "1",
"id": "ImagingStudy.availability",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.availability"
},
"isSummary": true
}, {
"path": "ImagingStudy.modalityList",
"min": 0,
"definition": "A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).",
"short": "All series modality if actual acquisition modalities",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "(0008,0061)",
"identity": "dicom"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
} ],
"description": "Type of acquired data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"alias": [ "ModalitiesInStudy" ],
"max": "*",
"id": "ImagingStudy.modalityList",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.modalityList"
},
"isSummary": true
}, {
"path": "ImagingStudy.patient",
"min": 1,
"definition": "The patient imaged in the study.",
"short": "Who the images are of",
"mapping": [ {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "(0010/*)",
"identity": "dicom"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
} ],
"mustSupport": true,
"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.patient",
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.patient"
},
"isSummary": true
}, {
"path": "ImagingStudy.context",
"min": 0,
"definition": "The encounter or episode at which the request is initiated.",
"short": "Originating context",
"mapping": [ {
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]",
"identity": "rim"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"max": "1",
"id": "ImagingStudy.context",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.context"
},
"isSummary": true
}, {
"path": "ImagingStudy.started",
"min": 0,
"definition": "Date and time the study started.",
"short": "When the study was started",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "(0008,0020)+(0008,0030)",
"identity": "dicom"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"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
}, {
"path": "ImagingStudy.basedOn",
"requirements": "To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT).",
"min": 0,
"definition": "A list of the diagnostic requests that resulted in this imaging study being performed.",
"short": "Request fulfilled",
"mapping": [ {
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]",
"identity": "rim"
}, {
"map": "who.cause",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-referralrequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedurerequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
} ],
"mustSupport": true,
"max": "*",
"id": "ImagingStudy.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.basedOn"
},
"isSummary": true
}, {
"path": "ImagingStudy.referrer",
"min": 0,
"definition": "The requesting/referring physician.",
"short": "Referring physician",
"mapping": [ {
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role",
"identity": "rim"
}, {
"map": "who.cause",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
} ],
"mustSupport": false,
"alias": [ "ReferringPhysiciansName" ],
"max": "1",
"id": "ImagingStudy.referrer",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.referrer"
},
"isSummary": true
}, {
"path": "ImagingStudy.interpreter",
"min": 0,
"definition": "Who read the study and interpreted the images or other content.",
"short": "Who interpreted images",
"mapping": [ {
"map": ".participation[typeCode=PRF].role",
"identity": "rim"
}, {
"map": "(0008,1060)",
"identity": "dicom"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
} ],
"mustSupport": false,
"alias": [ "Name of Physician(s) Reading Study" ],
"max": "*",
"id": "ImagingStudy.interpreter",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.interpreter"
},
"isSummary": true
}, {
"path": "ImagingStudy.endpoint",
"requirements": "Access methods for viewing (e.g., IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.",
"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.type.",
"short": "Study access endpoint",
"mapping": [ {
"map": "Not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
} ],
"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 information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.endpoint"
},
"isSummary": true
}, {
"path": "ImagingStudy.numberOfSeries",
"min": 0,
"definition": "Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.",
"short": "Number of Study Related Series",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "(0020,1206)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"alias": [ "NumberOfStudyRelatedSeries" ],
"max": "1",
"id": "ImagingStudy.numberOfSeries",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.numberOfSeries"
},
"isSummary": true
}, {
"path": "ImagingStudy.numberOfInstances",
"min": 0,
"definition": "Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.",
"short": "Number of Study Related Instances",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "(0020,1208)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"alias": [ "NumberOfStudyRelatedInstances" ],
"max": "1",
"id": "ImagingStudy.numberOfInstances",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.numberOfInstances"
},
"isSummary": true
}, {
"path": "ImagingStudy.procedureReference",
"min": 0,
"definition": "A reference to the performed Procedure.",
"short": "The performed Procedure reference",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]",
"identity": "rim"
}, {
"map": "(0008,1032)",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedure"
} ],
"mustSupport": true,
"max": "*",
"id": "ImagingStudy.procedureReference",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.procedureReference"
},
"isSummary": true
}, {
"path": "ImagingStudy.procedureCode",
"min": 0,
"definition": "The code for the performed procedure type.",
"short": "The performed procedure code",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingProcedureCode"
} ],
"description": "The performed procedure type",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/procedure-code"
}
},
"alias": [ "ProcedureCodeSequence" ],
"max": "*",
"id": "ImagingStudy.procedureCode",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.procedureCode"
},
"isSummary": true
}, {
"path": "ImagingStudy.reason",
"min": 0,
"definition": "Description of clinical condition indicating why the ImagingStudy was requested.",
"short": "Why the study was requested",
"mapping": [ {
"map": ".reasonCode",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingReason"
} ],
"description": "The reason for the study",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/procedure-reason"
}
},
"max": "1",
"id": "ImagingStudy.reason",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.reason"
},
"isSummary": true
}, {
"path": "ImagingStudy.description",
"min": 0,
"definition": "Institution-generated description or classification of the Study performed.",
"short": "Institution-generated description",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": "(0008,1030)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"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",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "ImagingStudy.series",
"min": 0,
"definition": "Each study has one or more series of images or other content.",
"short": "Each study has one or more series of instances",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "ImagingStudy.series",
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImagingStudy.series.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
}, {
"path": "ImagingStudy.series.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.uid",
"min": 1,
"definition": "Formal identifier for this series.",
"short": "Formal DICOM identifier for this series",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "(0020,000E)",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SeriesInstanceUID" ],
"max": "1",
"id": "ImagingStudy.series.uid",
"example": [ {
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
} ],
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.uid"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.number",
"min": 0,
"definition": "The numeric identifier of this series in the study.",
"short": "Numeric identifier of this series",
"mapping": [ {
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber",
"identity": "rim"
}, {
"map": "(0020,0011)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"alias": [ "SeriesNumber" ],
"max": "1",
"id": "ImagingStudy.series.number",
"example": [ {
"label": "General",
"valueInteger": 3
} ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.number"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.modality",
"min": 1,
"definition": "The modality of this series sequence.",
"short": "The modality of the instances in the series",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "(0008,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
} ],
"description": "Type of acquired data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"alias": [ "Modality" ],
"max": "1",
"id": "ImagingStudy.series.modality",
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.modality"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.description",
"min": 0,
"definition": "A description of the series.",
"short": "A short human readable summary of the series",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": "(0008,103E)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"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
}, {
"path": "ImagingStudy.series.numberOfInstances",
"min": 0,
"definition": "Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.",
"short": "Number of Series Related Instances",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber",
"identity": "rim"
}, {
"map": "(0020,1209)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"alias": [ "NumberOfSeriesRelatedInstances" ],
"max": "1",
"id": "ImagingStudy.series.numberOfInstances",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.numberOfInstances"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.availability",
"min": 0,
"definition": "Availability of series (online, offline or nearline).",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value",
"identity": "rim"
}, {
"map": "(0008,0056)",
"identity": "dicom"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InstanceAvailability"
} ],
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"alias": [ "InstanceAvailability" ],
"max": "1",
"id": "ImagingStudy.series.availability",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.availability"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.endpoint",
"requirements": "Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level.",
"min": 0,
"definition": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.",
"short": "Series access endpoint",
"mapping": [ {
"map": "Not supported",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
} ],
"max": "*",
"id": "ImagingStudy.series.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; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.",
"base": {
"max": "*",
"min": 0,
"path": "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 indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.",
"short": "Body part examined",
"mapping": [ {
"map": ".targetSiteCode",
"identity": "rim"
}, {
"map": "(0018,0015)",
"identity": "dicom"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "Codes describing anatomical locations. May include laterality.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/body-site"
}
},
"alias": [ "BodyPartExamined" ],
"max": "1",
"id": "ImagingStudy.series.bodySite",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.bodySite"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.laterality",
"min": 0,
"definition": "The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.",
"short": "Body part laterality",
"mapping": [ {
"map": ".targetSiteCode",
"identity": "rim"
}, {
"map": "(0020,0060)",
"identity": "dicom"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Laterality"
} ],
"description": "Codes describing body site laterality (left, right, etc.).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/bodysite-laterality"
}
},
"max": "1",
"id": "ImagingStudy.series.laterality",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.laterality"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.started",
"min": 0,
"definition": "The date and time the series was started.",
"short": "When the series started",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "(0008,0021) + (0008,0031)",
"identity": "dicom"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "ImagingStudy.series.started",
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.started"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.performer",
"min": 0,
"definition": "The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.",
"short": "Who performed the series",
"mapping": [ {
"map": ".participation[typeCode=PRF].role",
"identity": "rim"
}, {
"map": "(0008,1050) | (0008,1072)",
"identity": "dicom"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"alias": [ "PerformingPhysicianName", "OperatorName" ],
"max": "*",
"id": "ImagingStudy.series.performer",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.series.performer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (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.",
"short": "A single SOP instance from the series",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "ImagingStudy.series.instance",
"base": {
"max": "*",
"min": 0,
"path": "ImagingStudy.series.instance"
}
}, {
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImagingStudy.series.instance.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
}, {
"path": "ImagingStudy.series.instance.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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"
},
"isSummary": true
}, {
"path": "ImagingStudy.series.instance.uid",
"min": 1,
"definition": "Formal identifier for this image or other content.",
"short": "Formal DICOM identifier for this instance",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "(0008,0018)",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPInstanceUID" ],
"max": "1",
"id": "ImagingStudy.series.instance.uid",
"example": [ {
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903"
} ],
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.instance.uid"
}
}, {
"path": "ImagingStudy.series.instance.number",
"min": 0,
"definition": "The number of instance in the series.",
"short": "The number of this instance in the series",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber",
"identity": "rim"
}, {
"map": "(0020,0013)",
"identity": "dicom"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"alias": [ "InstanceNumber" ],
"max": "1",
"id": "ImagingStudy.series.instance.number",
"example": [ {
"label": "General",
"valueInteger": 1
} ],
"base": {
"max": "1",
"min": 0,
"path": "ImagingStudy.series.instance.number"
}
}, {
"path": "ImagingStudy.series.instance.sopClass",
"min": 1,
"definition": "DICOM instance type.",
"short": "DICOM class type",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value",
"identity": "rim"
}, {
"map": "(0008,0016)",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPClassUID" ],
"max": "1",
"id": "ImagingStudy.series.instance.sopClass",
"example": [ {
"label": "General",
"valueOid": "urn:oid:1.2.840.10008.5.1.4.1.1.2"
} ],
"base": {
"max": "1",
"min": 1,
"path": "ImagingStudy.series.instance.sopClass"
}
}, {
"path": "ImagingStudy.series.instance.title",
"min": 0,
"definition": "The description of the instance.",
"short": "Description of instance",
"mapping": [ {
"map": ".title",
"identity": "rim"
}, {
"map": "(0070,0080) | (0040,A043) > (0008,0104) | (0042,0010) | (0008,0008)",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"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"
}
} ]
},
"status": "draft",
"id": "177676cd-cb82-41b8-b5c2-139a7d4478b3",
"kind": "resource",
"url": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-imagingstudy",
"version": "3.1.0",
"differential": {
"element": [ {
"id": "ImagingStudy",
"path": "ImagingStudy",
"isModifier": false,
"mustSupport": false
}, {
"id": "ImagingStudy.patient",
"path": "ImagingStudy.patient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
} ],
"isModifier": false,
"mustSupport": true
}, {
"id": "ImagingStudy.started",
"path": "ImagingStudy.started",
"isModifier": false,
"mustSupport": true
}, {
"id": "ImagingStudy.basedOn",
"path": "ImagingStudy.basedOn",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-referralrequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedurerequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
} ],
"isModifier": false,
"mustSupport": true
}, {
"id": "ImagingStudy.referrer",
"path": "ImagingStudy.referrer",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "ImagingStudy.interpreter",
"path": "ImagingStudy.interpreter",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "ImagingStudy.procedureReference",
"path": "ImagingStudy.procedureReference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedure"
} ],
"isModifier": false,
"mustSupport": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/CQI",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
}