STU3 Candidate
DiagnosticsThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for imagingstudy
{
"resourceType": "StructureDefinition",
"id": "ImagingStudy",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "ii"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"name": "ImagingStudy",
"status": "draft",
"publisher": "Health Level Seven International (Imaging Integration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/imagemgt/index.cfm"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for ImagingStudy Resource",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM Tag Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "ImagingStudy",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ImagingStudy",
"path": "ImagingStudy",
"short": "A set of images produced in single study (one or more series of references images)",
"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.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14-1"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "ImagingStudy.id",
"path": "ImagingStudy.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ImagingStudy.meta",
"path": "ImagingStudy.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ImagingStudy.implicitRules",
"path": "ImagingStudy.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ImagingStudy.language",
"path": "ImagingStudy.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ImagingStudy.text",
"path": "ImagingStudy.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ImagingStudy.contained",
"path": "ImagingStudy.contained",
"short": "Contained, inline Resources",
"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.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.extension",
"path": "ImagingStudy.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.modifierExtension",
"path": "ImagingStudy.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.uid",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "dicom="
}
],
"path": "ImagingStudy.uid",
"short": "Formal DICOM identifier for the study",
"definition": "Formal identifier for the study.",
"alias": [
"StudyInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000D)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingStudy.accession",
"path": "ImagingStudy.accession",
"short": "Related workflow identifier (\"Accession Number\")",
"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).",
"alias": [
"AccessionNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "dicom",
"map": "(0008,0050)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingStudy.identifier",
"path": "ImagingStudy.identifier",
"short": "Other identifiers for the study",
"definition": "Other identifiers for the study.",
"alias": [
"StudyID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id (no means to distinguish from uid)"
},
{
"identity": "dicom",
"map": "(0020,0010)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingStudy.availability",
"path": "ImagingStudy.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"definition": "Availability of study (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"mapping": [
{
"identity": "rim",
"map": "Not supported"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ImagingStudy.modalityList",
"path": "ImagingStudy.modalityList",
"short": "All series modality if actual acquisition modalities",
"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).",
"alias": [
"ModalitiesInStudy"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "(0008,0061)"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "ImagingStudy.patient",
"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"
}
],
"path": "ImagingStudy.patient",
"short": "Who the images are of",
"definition": "The patient imaged in the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "(0010/*)"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ImagingStudy.context",
"path": "ImagingStudy.context",
"short": "Originating context",
"definition": "The encounter at which the request is initiated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "ImagingStudy.started",
"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"
}
],
"path": "ImagingStudy.started",
"short": "When the study was started",
"definition": "Date and Time the study started.",
"alias": [
"StudyDate",
"StudyTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"example": [
{
"label": "General",
"valueDateTime": "2011-01-01T11:01:20+03:00"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0008,0020)+(0008,0030)"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "ImagingStudy.basedOn",
"path": "ImagingStudy.basedOn",
"short": "Request fulfilled",
"definition": "A list of the diagnostic requests that resulted in this imaging study being performed.",
"requirements": "To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DiagnosticRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
},
{
"identity": "w5",
"map": "who.cause"
}
]
},
{
"id": "ImagingStudy.referrer",
"path": "ImagingStudy.referrer",
"short": "Referring physician",
"definition": "The requesting/referring physician.",
"alias": [
"ReferringPhysiciansName"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.cause"
}
]
},
{
"id": "ImagingStudy.interpreter",
"path": "ImagingStudy.interpreter",
"short": "Who interpreted images",
"definition": "Who read the study and interpreted the images or other content.",
"alias": [
"Name of Physician(s) Reading Study"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0008,1060)"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "ImagingStudy.baseLocation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "StudyBaseLocation"
}
],
"path": "ImagingStudy.baseLocation",
"short": "Study access service endpoint",
"definition": "Methods of accessing (e.g., retrieving, viewing) the study.",
"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,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "ImagingStudy.baseLocation.id",
"path": "ImagingStudy.baseLocation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.baseLocation.extension",
"path": "ImagingStudy.baseLocation.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.baseLocation.modifierExtension",
"path": "ImagingStudy.baseLocation.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.baseLocation.type",
"path": "ImagingStudy.baseLocation.type",
"short": "WADO-RS | WADO-URI | IID",
"definition": "The service type for accessing (e.g., retrieving, viewing) the DICOM instances.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of the service endpoint",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
}
},
{
"id": "ImagingStudy.baseLocation.url",
"path": "ImagingStudy.baseLocation.url",
"short": "Study access URL",
"definition": "The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.baseLocation.type.",
"comments": "This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to view, retrieve, or otherwise access the study or the study’s series or instances. For example, this element may be a DICOMweb WADO-RS endpoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "(0040,E023) WADO Retrieval Sequence > (0040,E010) Retrieve URI | \n(0040,E025) WADO-RS Retrieval Sequence > (0008,1190) Retrieve URI"
}
]
},
{
"id": "ImagingStudy.numberOfSeries",
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series",
"definition": "Number of Series in Study.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1206)"
}
]
},
{
"id": "ImagingStudy.numberOfInstances",
"path": "ImagingStudy.numberOfInstances",
"short": "Number of Study Related Instances",
"definition": "Number of SOP Instances in Study.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1208)"
}
]
},
{
"id": "ImagingStudy.procedure",
"path": "ImagingStudy.procedure",
"short": "Type of procedure performed",
"definition": "Type of procedure performed.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "(0008,1032)"
}
]
},
{
"id": "ImagingStudy.reason",
"path": "ImagingStudy.reason",
"short": "Reason for study",
"definition": "Description of clinical codition indicating why the ImagingStudy was requested.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The reason for the study"
},
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ImagingStudy.description",
"path": "ImagingStudy.description",
"short": "Institution-generated description",
"definition": "Institution-generated description or classification of the Study performed.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0008,1030)"
}
]
},
{
"id": "ImagingStudy.series",
"path": "ImagingStudy.series",
"short": "Each study has one or more series of instances",
"definition": "Each study has one or more series of images or other content.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
},
{
"id": "ImagingStudy.series.id",
"path": "ImagingStudy.series.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.extension",
"path": "ImagingStudy.series.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.modifierExtension",
"path": "ImagingStudy.series.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.series.uid",
"path": "ImagingStudy.series.uid",
"short": "Formal DICOM identifier for this series",
"definition": "Formal identifier for this series.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000E)"
}
]
},
{
"id": "ImagingStudy.series.number",
"path": "ImagingStudy.series.number",
"short": "Numeric identifier of this series",
"definition": "The Numeric identifier of this series in the study.",
"alias": [
"SeriesNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"example": [
{
"label": "General",
"valueUnsignedInt": 3
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
},
{
"identity": "dicom",
"map": "(0020,0011)"
}
]
},
{
"id": "ImagingStudy.series.modality",
"path": "ImagingStudy.series.modality",
"short": "The modality of the instances in the series",
"definition": "The modality of this series sequence.",
"alias": [
"Modality"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "(0008,0060)"
}
]
},
{
"id": "ImagingStudy.series.description",
"path": "ImagingStudy.series.description",
"short": "A short human readable summary of the series",
"definition": "A description of the series.",
"alias": [
"SeriesDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "CT Surview 180"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0008,103E)"
}
]
},
{
"id": "ImagingStudy.series.numberOfInstances",
"path": "ImagingStudy.series.numberOfInstances",
"short": "Number of Series Related Instances",
"definition": "Number of SOP Instances in Series.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1209)"
}
]
},
{
"id": "ImagingStudy.series.availability",
"path": "ImagingStudy.series.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"definition": "Availability of series (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
},
{
"identity": "dicom",
"map": "(0008,0056)"
}
]
},
{
"id": "ImagingStudy.series.baseLocation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SeriesBaseLocation"
}
],
"path": "ImagingStudy.series.baseLocation",
"short": "Series access endpoint",
"definition": "Methods of accessing (e.g. retrieving) the series.",
"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,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
},
{
"id": "ImagingStudy.series.baseLocation.id",
"path": "ImagingStudy.series.baseLocation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.baseLocation.extension",
"path": "ImagingStudy.series.baseLocation.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.baseLocation.modifierExtension",
"path": "ImagingStudy.series.baseLocation.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.series.baseLocation.type",
"path": "ImagingStudy.series.baseLocation.type",
"short": "WADO-RS | WADO-URI | IID",
"definition": "The service type for accessing (e.g., retrieving) the DICOM instances.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of the service endpoint",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
}
},
{
"id": "ImagingStudy.series.baseLocation.url",
"path": "ImagingStudy.series.baseLocation.url",
"short": "Series access URL",
"definition": "The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.series.baseLocation.type.",
"comments": "This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.series.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to retrieve, or otherwise access, the series or the series’ instances. For example, this element may be a DICOMweb WADO-RS endpoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "(0040,E023) WADO Retrieval Sequence > (0040,E010) Retrieve URI | \n(0040,E025) WADO-RS Retrieval Sequence > (0008,1190) Retrieve URI"
}
]
},
{
"id": "ImagingStudy.series.bodySite",
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined",
"definition": "Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": ".targetSiteCode"
},
{
"identity": "dicom",
"map": "(0018,0015)"
}
]
},
{
"id": "ImagingStudy.series.laterality",
"path": "ImagingStudy.series.laterality",
"short": "Body part laterality",
"definition": "Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Codes describing body site laterality (left, right, etc.).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/bodysite-laterality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".targetSiteCode"
},
{
"identity": "dicom",
"map": "(0020,0060)"
}
]
},
{
"id": "ImagingStudy.series.started",
"path": "ImagingStudy.series.started",
"short": "When the series started",
"definition": "The date and time the series was started.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0008,0021) + (0008,0031)"
}
]
},
{
"id": "ImagingStudy.series.instance",
"path": "ImagingStudy.series.instance",
"short": "A single SOP instance from the series",
"definition": "A single SOP Instance within the series, e.g. an image, or presentation state.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
},
{
"id": "ImagingStudy.series.instance.id",
"path": "ImagingStudy.series.instance.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.instance.extension",
"path": "ImagingStudy.series.instance.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.instance.modifierExtension",
"path": "ImagingStudy.series.instance.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.series.instance.uid",
"path": "ImagingStudy.series.instance.uid",
"short": "Formal DICOM identifier for this instance",
"definition": "Formal identifier for this image or other content.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0008,0018)"
}
]
},
{
"id": "ImagingStudy.series.instance.number",
"path": "ImagingStudy.series.instance.number",
"short": "The number of this instance in the series",
"definition": "The number of instance in the series.",
"alias": [
"InstanceNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"example": [
{
"label": "General",
"valueUnsignedInt": 1
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
},
{
"identity": "dicom",
"map": "(0020,0013)"
}
]
},
{
"id": "ImagingStudy.series.instance.sopClass",
"path": "ImagingStudy.series.instance.sopClass",
"short": "DICOM class type",
"definition": "DICOM instance type.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:1.2.840.10008.5.1.4.1.1.2"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
},
{
"identity": "dicom",
"map": "(0008,0016)"
}
]
},
{
"id": "ImagingStudy.series.instance.title",
"path": "ImagingStudy.series.instance.title",
"short": "Description of instance",
"definition": "The description of the instance.",
"comments": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "dicom",
"map": "(0070,0080) | (0040,A043) > (0008,0104) | (0042,0010) | (0008,0008)"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ImagingStudy",
"path": "ImagingStudy",
"short": "A set of images produced in single study (one or more series of references images)",
"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.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14-1"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "ImagingStudy.uid",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "dicom="
}
],
"path": "ImagingStudy.uid",
"short": "Formal DICOM identifier for the study",
"definition": "Formal identifier for the study.",
"alias": [
"StudyInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000D)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingStudy.accession",
"path": "ImagingStudy.accession",
"short": "Related workflow identifier (\"Accession Number\")",
"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).",
"alias": [
"AccessionNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "dicom",
"map": "(0008,0050)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingStudy.identifier",
"path": "ImagingStudy.identifier",
"short": "Other identifiers for the study",
"definition": "Other identifiers for the study.",
"alias": [
"StudyID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id (no means to distinguish from uid)"
},
{
"identity": "dicom",
"map": "(0020,0010)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingStudy.availability",
"path": "ImagingStudy.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"definition": "Availability of study (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"mapping": [
{
"identity": "rim",
"map": "Not supported"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ImagingStudy.modalityList",
"path": "ImagingStudy.modalityList",
"short": "All series modality if actual acquisition modalities",
"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).",
"alias": [
"ModalitiesInStudy"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "(0008,0061)"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "ImagingStudy.patient",
"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"
}
],
"path": "ImagingStudy.patient",
"short": "Who the images are of",
"definition": "The patient imaged in the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "(0010/*)"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ImagingStudy.context",
"path": "ImagingStudy.context",
"short": "Originating context",
"definition": "The encounter at which the request is initiated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "ImagingStudy.started",
"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"
}
],
"path": "ImagingStudy.started",
"short": "When the study was started",
"definition": "Date and Time the study started.",
"alias": [
"StudyDate",
"StudyTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"example": [
{
"label": "General",
"valueDateTime": "2011-01-01T11:01:20+03:00"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0008,0020)+(0008,0030)"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "ImagingStudy.basedOn",
"path": "ImagingStudy.basedOn",
"short": "Request fulfilled",
"definition": "A list of the diagnostic requests that resulted in this imaging study being performed.",
"requirements": "To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DiagnosticRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
},
{
"identity": "w5",
"map": "who.cause"
}
]
},
{
"id": "ImagingStudy.referrer",
"path": "ImagingStudy.referrer",
"short": "Referring physician",
"definition": "The requesting/referring physician.",
"alias": [
"ReferringPhysiciansName"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.cause"
}
]
},
{
"id": "ImagingStudy.interpreter",
"path": "ImagingStudy.interpreter",
"short": "Who interpreted images",
"definition": "Who read the study and interpreted the images or other content.",
"alias": [
"Name of Physician(s) Reading Study"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0008,1060)"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "ImagingStudy.baseLocation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "StudyBaseLocation"
}
],
"path": "ImagingStudy.baseLocation",
"short": "Study access service endpoint",
"definition": "Methods of accessing (e.g., retrieving, viewing) the study.",
"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,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "ImagingStudy.baseLocation.type",
"path": "ImagingStudy.baseLocation.type",
"short": "WADO-RS | WADO-URI | IID",
"definition": "The service type for accessing (e.g., retrieving, viewing) the DICOM instances.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of the service endpoint",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
}
},
{
"id": "ImagingStudy.baseLocation.url",
"path": "ImagingStudy.baseLocation.url",
"short": "Study access URL",
"definition": "The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.baseLocation.type.",
"comments": "This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to view, retrieve, or otherwise access the study or the study’s series or instances. For example, this element may be a DICOMweb WADO-RS endpoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "(0040,E023) WADO Retrieval Sequence > (0040,E010) Retrieve URI | \n(0040,E025) WADO-RS Retrieval Sequence > (0008,1190) Retrieve URI"
}
]
},
{
"id": "ImagingStudy.numberOfSeries",
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series",
"definition": "Number of Series in Study.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1206)"
}
]
},
{
"id": "ImagingStudy.numberOfInstances",
"path": "ImagingStudy.numberOfInstances",
"short": "Number of Study Related Instances",
"definition": "Number of SOP Instances in Study.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1208)"
}
]
},
{
"id": "ImagingStudy.procedure",
"path": "ImagingStudy.procedure",
"short": "Type of procedure performed",
"definition": "Type of procedure performed.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "(0008,1032)"
}
]
},
{
"id": "ImagingStudy.reason",
"path": "ImagingStudy.reason",
"short": "Reason for study",
"definition": "Description of clinical codition indicating why the ImagingStudy was requested.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The reason for the study"
},
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ImagingStudy.description",
"path": "ImagingStudy.description",
"short": "Institution-generated description",
"definition": "Institution-generated description or classification of the Study performed.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0008,1030)"
}
]
},
{
"id": "ImagingStudy.series",
"path": "ImagingStudy.series",
"short": "Each study has one or more series of instances",
"definition": "Each study has one or more series of images or other content.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
},
{
"id": "ImagingStudy.series.uid",
"path": "ImagingStudy.series.uid",
"short": "Formal DICOM identifier for this series",
"definition": "Formal identifier for this series.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000E)"
}
]
},
{
"id": "ImagingStudy.series.number",
"path": "ImagingStudy.series.number",
"short": "Numeric identifier of this series",
"definition": "The Numeric identifier of this series in the study.",
"alias": [
"SeriesNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"example": [
{
"label": "General",
"valueUnsignedInt": 3
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
},
{
"identity": "dicom",
"map": "(0020,0011)"
}
]
},
{
"id": "ImagingStudy.series.modality",
"path": "ImagingStudy.series.modality",
"short": "The modality of the instances in the series",
"definition": "The modality of this series sequence.",
"alias": [
"Modality"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "(0008,0060)"
}
]
},
{
"id": "ImagingStudy.series.description",
"path": "ImagingStudy.series.description",
"short": "A short human readable summary of the series",
"definition": "A description of the series.",
"alias": [
"SeriesDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "CT Surview 180"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0008,103E)"
}
]
},
{
"id": "ImagingStudy.series.numberOfInstances",
"path": "ImagingStudy.series.numberOfInstances",
"short": "Number of Series Related Instances",
"definition": "Number of SOP Instances in Series.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1209)"
}
]
},
{
"id": "ImagingStudy.series.availability",
"path": "ImagingStudy.series.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"definition": "Availability of series (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
},
{
"identity": "dicom",
"map": "(0008,0056)"
}
]
},
{
"id": "ImagingStudy.series.baseLocation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SeriesBaseLocation"
}
],
"path": "ImagingStudy.series.baseLocation",
"short": "Series access endpoint",
"definition": "Methods of accessing (e.g. retrieving) the series.",
"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,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "ImagingStudy.series.baseLocation.type",
"path": "ImagingStudy.series.baseLocation.type",
"short": "WADO-RS | WADO-URI | IID",
"definition": "The service type for accessing (e.g., retrieving) the DICOM instances.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of the service endpoint",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
}
},
{
"id": "ImagingStudy.series.baseLocation.url",
"path": "ImagingStudy.series.baseLocation.url",
"short": "Series access URL",
"definition": "The service URL for accessing the study. The interpretation of the URL depends on the type of the service specified in ImagingManifest.study.series.baseLocation.type.",
"comments": "This URL is to a service endpoint for the particular service indicated by ImagingManifest.study.series.baseLocation.type. Depending on the type of service, it is may be used to construct a URL to retrieve, or otherwise access, the series or the series’ instances. For example, this element may be a DICOMweb WADO-RS endpoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "(0040,E023) WADO Retrieval Sequence > (0040,E010) Retrieve URI | \n(0040,E025) WADO-RS Retrieval Sequence > (0008,1190) Retrieve URI"
}
]
},
{
"id": "ImagingStudy.series.bodySite",
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined",
"definition": "Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": ".targetSiteCode"
},
{
"identity": "dicom",
"map": "(0018,0015)"
}
]
},
{
"id": "ImagingStudy.series.laterality",
"path": "ImagingStudy.series.laterality",
"short": "Body part laterality",
"definition": "Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Codes describing body site laterality (left, right, etc.).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/bodysite-laterality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".targetSiteCode"
},
{
"identity": "dicom",
"map": "(0020,0060)"
}
]
},
{
"id": "ImagingStudy.series.started",
"path": "ImagingStudy.series.started",
"short": "When the series started",
"definition": "The date and time the series was started.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0008,0021) + (0008,0031)"
}
]
},
{
"id": "ImagingStudy.series.instance",
"path": "ImagingStudy.series.instance",
"short": "A single SOP instance from the series",
"definition": "A single SOP Instance within the series, e.g. an image, or presentation state.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
},
{
"id": "ImagingStudy.series.instance.uid",
"path": "ImagingStudy.series.instance.uid",
"short": "Formal DICOM identifier for this instance",
"definition": "Formal identifier for this image or other content.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0008,0018)"
}
]
},
{
"id": "ImagingStudy.series.instance.number",
"path": "ImagingStudy.series.instance.number",
"short": "The number of this instance in the series",
"definition": "The number of instance in the series.",
"alias": [
"InstanceNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"example": [
{
"label": "General",
"valueUnsignedInt": 1
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
},
{
"identity": "dicom",
"map": "(0020,0013)"
}
]
},
{
"id": "ImagingStudy.series.instance.sopClass",
"path": "ImagingStudy.series.instance.sopClass",
"short": "DICOM class type",
"definition": "DICOM instance type.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"example": [
{
"label": "General",
"valueOid": "urn:oid:1.2.840.10008.5.1.4.1.1.2"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
},
{
"identity": "dicom",
"map": "(0008,0016)"
}
]
},
{
"id": "ImagingStudy.series.instance.title",
"path": "ImagingStudy.series.instance.title",
"short": "Description of instance",
"definition": "The description of the instance.",
"comments": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "dicom",
"map": "(0070,0080) | (0040,A043) > (0008,0104) | (0042,0010) | (0008,0008)"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:26+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change