DSTU2 Ballot Source
This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). 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": "2015-04-03T14:24:32.000+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"name": "ImagingStudy",
"publisher": "HL7 FHIR Project (Imaging Integration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/imagemgt/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ImagingStudy Resource",
"status": "draft",
"date": "2015-04-03T14:24:32+11:00",
"mapping": [
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"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.",
"alias": [
"Manifest",
"XDS-I summary",
"Key Images"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14.1"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. 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. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"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",
"type": [
{
"code": "Meta"
}
]
},
{
"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",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.started",
"short": "When the study was started (0008,0020)+(0008,0030)",
"definition": "Date and Time the study started. Timezone Offset From UTC.",
"alias": [
"StudyDate",
"StudyTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"exampleDateTime": "2011-01-01T11:01:20+03:00",
"mapping": [
{
"identity": "dicom",
"map": "0008,0020+0008,0030"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.patient",
"short": "Who the images are of",
"definition": "The patient imaged in the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0010/*"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingStudy.uid",
"short": "Formal identifier for the study (0020,000D)",
"definition": "Formal identifier for the study.",
"alias": [
"StudyInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045",
"mapping": [
{
"identity": "dicom",
"map": "0020,000D"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.accession",
"short": "Accession Number (0008,0050)",
"definition": "Accession Number.",
"alias": [
"AccessionNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0050"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
}
]
},
{
"path": "ImagingStudy.identifier",
"short": "Other identifiers for the study (0020,0010)",
"definition": "Other identifiers for the study.",
"alias": [
"StudyID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,0010"
},
{
"identity": "rim",
"map": ".id (no means to distinguish from uid)"
}
]
},
{
"path": "ImagingStudy.order",
"short": "Order(s) that caused this study to be performed",
"definition": "A list of the diagnostic orders 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",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
}
]
},
{
"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": "code"
}
],
"binding": {
"name": "ImagingModality",
"strength": "required",
"description": "Type of acquired image data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/imaging-modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0061"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.referrer",
"short": "Referring physician (0008,0090)",
"definition": "The requesting/referring physician.",
"alias": [
"ReferringPhysiciansName"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0090"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
}
]
},
{
"path": "ImagingStudy.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of study (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"path": "ImagingStudy.url",
"short": "Retrieve URI (0008,1190)",
"definition": "WADO-RS resource where Study is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series (0020,1206)",
"definition": "Number of Series in Study.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1206)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.numberOfInstances",
"short": "Number of Study Related Instances (0020,1208)",
"definition": "Number of SOP Instances in Study.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1208)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.clinicalInformation",
"short": "Diagnoses etc with request (0040,1002)",
"definition": "Diagnoses etc provided with request.",
"alias": [
"AdmittingDiagnosesDescription",
"AdditionalPatientHistory"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0040,1002, 0008,1080"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PERT].target"
}
]
},
{
"path": "ImagingStudy.procedure",
"short": "Type of procedure performed (0008,1032)",
"definition": "Type of procedure performed.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1032"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.interpreter",
"short": "Who interpreted images (0008,1060)",
"definition": "Who read study and interpreted the images.",
"alias": [
"Name of Physician(s) Reading Study"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1060"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
}
]
},
{
"path": "ImagingStudy.description",
"short": "Institution-generated description (0008,1030)",
"definition": "Institution-generated description or classification of the Study performed.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1030"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series",
"short": "Each study has one or more series of instances",
"definition": "Each study has one or more series of image instances.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.series.number",
"short": "Numeric identifier of this series (0020,0011)",
"definition": "The Numeric identifier of this series in the study.",
"alias": [
"SeriesNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"exampleInteger": 3,
"mapping": [
{
"identity": "dicom",
"map": "0020,0011"
},
{
"identity": "rim",
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.modality",
"short": "The modality of the instances in the series (0008,0060)",
"definition": "The modality of this series sequence.",
"alias": [
"Modality"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"exampleCode": "CT",
"binding": {
"name": "Modality",
"strength": "required",
"description": "Type of data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0060"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.uid",
"short": "Formal identifier for this series (0020,000E)",
"definition": "Formal identifier for this series.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630",
"mapping": [
{
"identity": "dicom",
"map": "0020,000E"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.description",
"short": "A description of the series (0008,103E)",
"definition": "A description of the series.",
"alias": [
"SeriesDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "CT Surview 180",
"mapping": [
{
"identity": "dicom",
"map": "0008,103E"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series.numberOfInstances",
"short": "Number of Series Related Instances (0020,1209)",
"definition": "Number of SOP Instances in Series.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,1209"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.series.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of series (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
}
]
},
{
"path": "ImagingStudy.series.url",
"short": "Retrieve URI (0008,1115 > 0008,1190)",
"definition": "WADO-RS resource where the Series is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1115 > 0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined (Map from 0018,0015)",
"definition": "Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0018,0015"
},
{
"identity": "rim",
"map": ".targetSiteCode"
}
]
},
{
"path": "ImagingStudy.series.laterality",
"short": "Body part laterality",
"definition": "Laterality if bodySite is paired anatomic structure and laterality is not pre-coordinated in bodySite code, map from (0020, 0060).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "200060"
}
]
},
{
"path": "ImagingStudy.series.dateTime",
"short": "When the series started",
"definition": "The date and time when the series was started.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.series.instance",
"short": "A single instance taken from a patient (image or other)",
"definition": "A single SOP Instance within the series, e.g., an image, or presentation state.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.series.instance.number",
"short": "The number of this instance in the series (0020,0013)",
"definition": "The number of this image in the series.",
"alias": [
"InstanceNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"exampleInteger": 1,
"mapping": [
{
"identity": "dicom",
"map": "0020,0013"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.instance.uid",
"short": "Formal identifier for this instance (0008,0018)",
"definition": "Formal identifier for this image.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903",
"mapping": [
{
"identity": "dicom",
"map": "0008,0018"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.instance.sopclass",
"short": "DICOM class type (0008,0016)",
"definition": "DICOM Image type.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
"mapping": [
{
"identity": "dicom",
"map": "0008,0016"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
}
]
},
{
"path": "ImagingStudy.series.instance.type",
"short": "Type of instance (image etc) (0004,1430)",
"definition": "A human-friendly SOP Class name.",
"comments": "E.g., 'CT image', 'MR multi-frame', 'blending presentation'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0004,1430"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.instance.title",
"short": "Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)",
"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": "dicom",
"map": "0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "ImagingStudy.series.instance.content",
"short": "Content of the instance",
"definition": "Content of the instance or a rendering thereof (e.g., a JPEG of an image, or an XML of a structured report). May be represented by inline encoding, or by a URL reference to a WADO-RS service that makes the instance available. Multiple content attachments may be used for alternate representations of the instance.",
"comments": "Each instance may have a url and an attachment. Both represent the same information, but using different approaches. The attachment is a reference to a FHIR resource (Media, Document, etc).",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text.binary"
}
]
}
]
},
"differential": {
"element": [
{
"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.",
"alias": [
"Manifest",
"XDS-I summary",
"Key Images"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14.1"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.started",
"short": "When the study was started (0008,0020)+(0008,0030)",
"definition": "Date and Time the study started. Timezone Offset From UTC.",
"alias": [
"StudyDate",
"StudyTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"exampleDateTime": "2011-01-01T11:01:20+03:00",
"mapping": [
{
"identity": "dicom",
"map": "0008,0020+0008,0030"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.patient",
"short": "Who the images are of",
"definition": "The patient imaged in the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0010/*"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingStudy.uid",
"short": "Formal identifier for the study (0020,000D)",
"definition": "Formal identifier for the study.",
"alias": [
"StudyInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045",
"mapping": [
{
"identity": "dicom",
"map": "0020,000D"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.accession",
"short": "Accession Number (0008,0050)",
"definition": "Accession Number.",
"alias": [
"AccessionNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0050"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
}
]
},
{
"path": "ImagingStudy.identifier",
"short": "Other identifiers for the study (0020,0010)",
"definition": "Other identifiers for the study.",
"alias": [
"StudyID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,0010"
},
{
"identity": "rim",
"map": ".id (no means to distinguish from uid)"
}
]
},
{
"path": "ImagingStudy.order",
"short": "Order(s) that caused this study to be performed",
"definition": "A list of the diagnostic orders 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",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
}
]
},
{
"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": "code"
}
],
"binding": {
"name": "ImagingModality",
"strength": "required",
"description": "Type of acquired image data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/imaging-modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0061"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.referrer",
"short": "Referring physician (0008,0090)",
"definition": "The requesting/referring physician.",
"alias": [
"ReferringPhysiciansName"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0090"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
}
]
},
{
"path": "ImagingStudy.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of study (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"path": "ImagingStudy.url",
"short": "Retrieve URI (0008,1190)",
"definition": "WADO-RS resource where Study is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series (0020,1206)",
"definition": "Number of Series in Study.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1206)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.numberOfInstances",
"short": "Number of Study Related Instances (0020,1208)",
"definition": "Number of SOP Instances in Study.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1208)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.clinicalInformation",
"short": "Diagnoses etc with request (0040,1002)",
"definition": "Diagnoses etc provided with request.",
"alias": [
"AdmittingDiagnosesDescription",
"AdditionalPatientHistory"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0040,1002, 0008,1080"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PERT].target"
}
]
},
{
"path": "ImagingStudy.procedure",
"short": "Type of procedure performed (0008,1032)",
"definition": "Type of procedure performed.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1032"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.interpreter",
"short": "Who interpreted images (0008,1060)",
"definition": "Who read study and interpreted the images.",
"alias": [
"Name of Physician(s) Reading Study"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1060"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
}
]
},
{
"path": "ImagingStudy.description",
"short": "Institution-generated description (0008,1030)",
"definition": "Institution-generated description or classification of the Study performed.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1030"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series",
"short": "Each study has one or more series of instances",
"definition": "Each study has one or more series of image instances.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.series.number",
"short": "Numeric identifier of this series (0020,0011)",
"definition": "The Numeric identifier of this series in the study.",
"alias": [
"SeriesNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"exampleInteger": 3,
"mapping": [
{
"identity": "dicom",
"map": "0020,0011"
},
{
"identity": "rim",
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.modality",
"short": "The modality of the instances in the series (0008,0060)",
"definition": "The modality of this series sequence.",
"alias": [
"Modality"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"exampleCode": "CT",
"binding": {
"name": "Modality",
"strength": "required",
"description": "Type of data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0060"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.uid",
"short": "Formal identifier for this series (0020,000E)",
"definition": "Formal identifier for this series.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630",
"mapping": [
{
"identity": "dicom",
"map": "0020,000E"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.description",
"short": "A description of the series (0008,103E)",
"definition": "A description of the series.",
"alias": [
"SeriesDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "CT Surview 180",
"mapping": [
{
"identity": "dicom",
"map": "0008,103E"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series.numberOfInstances",
"short": "Number of Series Related Instances (0020,1209)",
"definition": "Number of SOP Instances in Series.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,1209"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.series.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of series (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
}
]
},
{
"path": "ImagingStudy.series.url",
"short": "Retrieve URI (0008,1115 > 0008,1190)",
"definition": "WADO-RS resource where the Series is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1115 > 0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined (Map from 0018,0015)",
"definition": "Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0018,0015"
},
{
"identity": "rim",
"map": ".targetSiteCode"
}
]
},
{
"path": "ImagingStudy.series.laterality",
"short": "Body part laterality",
"definition": "Laterality if bodySite is paired anatomic structure and laterality is not pre-coordinated in bodySite code, map from (0020, 0060).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "200060"
}
]
},
{
"path": "ImagingStudy.series.dateTime",
"short": "When the series started",
"definition": "The date and time when the series was started.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.series.instance",
"short": "A single instance taken from a patient (image or other)",
"definition": "A single SOP Instance within the series, e.g., an image, or presentation state.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.series.instance.number",
"short": "The number of this instance in the series (0020,0013)",
"definition": "The number of this image in the series.",
"alias": [
"InstanceNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"exampleInteger": 1,
"mapping": [
{
"identity": "dicom",
"map": "0020,0013"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.instance.uid",
"short": "Formal identifier for this instance (0008,0018)",
"definition": "Formal identifier for this image.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903",
"mapping": [
{
"identity": "dicom",
"map": "0008,0018"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.instance.sopclass",
"short": "DICOM class type (0008,0016)",
"definition": "DICOM Image type.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
"mapping": [
{
"identity": "dicom",
"map": "0008,0016"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
}
]
},
{
"path": "ImagingStudy.series.instance.type",
"short": "Type of instance (image etc) (0004,1430)",
"definition": "A human-friendly SOP Class name.",
"comments": "E.g., 'CT image', 'MR multi-frame', 'blending presentation'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0004,1430"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.instance.title",
"short": "Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)",
"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": "dicom",
"map": "0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "ImagingStudy.series.instance.content",
"short": "Content of the instance",
"definition": "Content of the instance or a rendering thereof (e.g., a JPEG of an image, or an XML of a structured report). May be represented by inline encoding, or by a URL reference to a WADO-RS service that makes the instance available. Multiple content attachments may be used for alternate representations of the instance.",
"comments": "Each instance may have a url and an attachment. Both represent the same information, but using different approaches. The attachment is a reference to a FHIR resource (Media, Document, etc).",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text.binary"
}
]
}
]
}
}
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 DSTU (v0.5.0-5149) generated on Fri, Apr 3, 2015 14:32+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change