R4 Ballot #1 (Mixed Normative/Trial use)
DiagnosticsThis page is part of the FHIR Specification (v3.3.0: R4 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
| Imaging Integration Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Patient |
StructureDefinition for imagingstudy
{
"resourceType": "StructureDefinition",
"id": "ImagingStudy",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "ii"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"name": "ImagingStudy",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"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"
}
]
}
],
"description": "Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of 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.",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"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/fivews",
"name": "FiveWs Pattern"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 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": "*",
"base": {
"path": "ImagingStudy",
"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 or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14-1"
}
]
},
{
"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.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"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 might 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"
}
],
"isModifier": false,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "ImagingStudy.language",
"path": "ImagingStudy.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "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 can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"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.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"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. 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.identifier",
"path": "ImagingStudy.identifier",
"short": "Identifiers for the whole study",
"definition": "DICOM Study Instance UID, and Accession Number.",
"requirements": "UID would be encoded using FHIR OID encoding recommendation. Study Instance UID is indicated with use of \"official\", accession with use of \"secondary\".",
"alias": [
"StudyInstanceUID",
"AccessionNumber"
],
"min": 0,
"max": "*",
"base": {
"path": "ImagingStudy.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id and .inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "dicom",
"map": "(0020,0010)+(0020,000D)+(0008,0050)+(0008,0050)"
}
]
},
{
"id": "ImagingStudy.status",
"path": "ImagingStudy.status",
"short": "registered | available | cancelled | entered-in-error | unknown",
"definition": "The current state of the ImagingStudy.",
"comment": "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min": 1,
"max": "1",
"base": {
"path": "ImagingStudy.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingStudyStatus"
}
],
"strength": "required",
"description": "The status of the ImagingStudy",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/imagingstudy-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".status"
}
]
},
{
"id": "ImagingStudy.modality",
"path": "ImagingStudy.modality",
"short": "All series modality if actual acquisition modalities",
"definition": "A list of all the series.modality 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": "*",
"base": {
"path": "ImagingStudy.modality",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
}
],
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetCanonical": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "(0008,0061)"
}
]
},
{
"id": "ImagingStudy.subject",
"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.subject",
"short": "Who or what is the subject of the study",
"definition": "The subject, typically a patient, of the imaging study.",
"comment": "QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.",
"min": 1,
"max": "1",
"base": {
"path": "ImagingStudy.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Group"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "(0010/*)"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "ImagingStudy.context",
"path": "ImagingStudy.context",
"short": "Originating context",
"definition": "The encounter or episode at which the request is initiated.",
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.context",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"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",
"base": {
"path": "ImagingStudy.started",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"example": [
{
"label": "General",
"valueDateTime": "2011-01-01T11:01:20+03:00"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.init"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0008,0020)+(0008,0030)"
}
]
},
{
"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": "*",
"base": {
"path": "ImagingStudy.basedOn",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/Appointment",
"http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"http://hl7.org/fhir/StructureDefinition/Task"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.basedOn"
},
{
"identity": "w5",
"map": "FiveWs.cause"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
},
{
"identity": "dicom",
"map": "(0032,1064)"
}
]
},
{
"id": "ImagingStudy.referrer",
"path": "ImagingStudy.referrer",
"short": "Referring physician",
"definition": "The requesting/referring physician.",
"alias": [
"ReferringPhysiciansName"
],
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.referrer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.cause"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
},
{
"identity": "dicom",
"map": "(0008,0090)+(0008,0096)"
}
]
},
{
"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": "*",
"base": {
"path": "ImagingStudy.interpreter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0008,1060)"
}
]
},
{
"id": "ImagingStudy.endpoint",
"path": "ImagingStudy.endpoint",
"short": "Study access endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.",
"comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.",
"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": "*",
"base": {
"path": "ImagingStudy.endpoint",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"id": "ImagingStudy.numberOfSeries",
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series",
"definition": "Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.numberOfSeries",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"isModifier": false,
"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. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.numberOfInstances",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1208)"
}
]
},
{
"id": "ImagingStudy.procedureReference",
"path": "ImagingStudy.procedureReference",
"short": "The performed Procedure reference",
"definition": "A reference to the performed Procedure.",
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.procedureReference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Procedure"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.partOf"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "(0008,1032)"
}
]
},
{
"id": "ImagingStudy.procedureCode",
"path": "ImagingStudy.procedureCode",
"short": "The performed procedure code",
"definition": "The code for the performed procedure type.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"base": {
"path": "ImagingStudy.procedureCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingProcedureCode"
}
],
"strength": "extensible",
"description": "The performed procedure type",
"valueSetCanonical": "http://www.rsna.org/RadLex_Playbook.aspx"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "(0008,0032)"
}
]
},
{
"id": "ImagingStudy.location",
"path": "ImagingStudy.location",
"short": "Where ImagingStudy occurred",
"definition": "The principal physical location where the ImagingStudy was performed.",
"requirements": "Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).",
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.location",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Location"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.location"
},
{
"identity": "w5",
"map": "FiveWs.where[x]"
},
{
"identity": "v2",
"map": "EVN.7"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
},
{
"identity": "dicom",
"map": "(0008,1040)+(0040,0243)"
}
]
},
{
"id": "ImagingStudy.reasonCode",
"path": "ImagingStudy.reasonCode",
"short": "Why the study was requested",
"definition": "Description of clinical condition indicating why the ImagingStudy was requested.",
"min": 0,
"max": "*",
"base": {
"path": "ImagingStudy.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingReason"
}
],
"strength": "example",
"description": "The reason for the study",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/procedure-reason"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "ImagingStudy.reasonReference",
"path": "ImagingStudy.reasonReference",
"short": "Why was study performed",
"definition": "Indicates another resource whose existence justifies this Study.",
"min": 0,
"max": "*",
"base": {
"path": "ImagingStudy.reasonReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Media",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "v2",
"map": "EVN.4 or by domain"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"id": "ImagingStudy.note",
"path": "ImagingStudy.note",
"short": "Institution-generated description",
"definition": "Institution-generated description or classification of the Study performed.",
"requirements": "Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "*",
"base": {
"path": "ImagingStudy.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0008,1030)+(0040,0280)"
}
]
},
{
"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": "*",
"base": {
"path": "ImagingStudy.series",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"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"
}
],
"isModifier": false,
"isSummary": false,
"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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.series.identifier",
"path": "ImagingStudy.series.identifier",
"short": "Formal DICOM identifier for this series",
"definition": "Formal identifier for this series.",
"requirements": "DICOM Series UID.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"base": {
"path": "ImagingStudy.series.identifier",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"example": [
{
"label": "General",
"valueIdentifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
}
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"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",
"base": {
"path": "ImagingStudy.series.number",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"example": [
{
"label": "General",
"valueUnsignedInt": 3
}
],
"isModifier": false,
"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",
"base": {
"path": "ImagingStudy.series.modality",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
}
],
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetCanonical": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html"
},
"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",
"base": {
"path": "ImagingStudy.series.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "CT Surview 180"
}
],
"isModifier": false,
"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 the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.series.numberOfInstances",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"isModifier": false,
"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.endpoint",
"path": "ImagingStudy.series.endpoint",
"short": "Series access endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.",
"comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.",
"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": "*",
"base": {
"path": "ImagingStudy.series.endpoint",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"id": "ImagingStudy.series.bodySite",
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined",
"definition": "The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.series.bodySite",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
}
],
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality.",
"valueSetCanonical": "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": "The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.",
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.series.laterality",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Laterality"
}
],
"strength": "example",
"description": "Codes describing body site laterality (left, right, etc.).",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/bodysite-laterality"
},
"mapping": [
{
"identity": "rim",
"map": ".targetSiteCode"
},
{
"identity": "dicom",
"map": "(0020,0060)"
}
]
},
{
"id": "ImagingStudy.series.specimen",
"path": "ImagingStudy.series.specimen",
"short": "Specimen imaged",
"definition": "The specimen imaged, e.g., for whole slide imaging of a biopsy.",
"min": 0,
"max": "*",
"base": {
"path": "ImagingStudy.series.specimen",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Specimen"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
},
{
"identity": "dicom",
"map": "(0040,0551) + (0040,0562)"
}
]
},
{
"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",
"base": {
"path": "ImagingStudy.series.started",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0008,0021) + (0008,0031)"
}
]
},
{
"id": "ImagingStudy.series.performer",
"path": "ImagingStudy.series.performer",
"short": "Who performed the series",
"definition": "Indicates who or what performed the series and how they were involved.",
"comment": "If the person who performed the series is not known, their Organization may be recorded. A patient, or related person, may be the performer, e.g. for patient-captured images.",
"requirements": "The performer is recorded at the series level, since each series in a study may be performed by a different performer, at different times, and using different devices. A series may be performed by multiple performers.",
"alias": [
"PerformingPhysicianName",
"OperatorName"
],
"min": 0,
"max": "*",
"base": {
"path": "ImagingStudy.series.performer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0008,1050) | (0008,1072)"
}
]
},
{
"id": "ImagingStudy.series.performer.id",
"path": "ImagingStudy.series.performer.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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.performer.extension",
"path": "ImagingStudy.series.performer.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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingStudy.series.performer.modifierExtension",
"path": "ImagingStudy.series.performer.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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.series.performer.function",
"path": "ImagingStudy.series.performer.function",
"short": "Type of performance",
"definition": "Distinguishes the type of involvement of the performer in the series.",
"requirements": "Allows disambiguation of the types of involvement of different performers.",
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.series.performer.function",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventPerformerFunction"
}
],
"strength": "required",
"description": "The type of involvement of the performer",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/series-performer-function"
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
}
]
},
{
"id": "ImagingStudy.series.performer.actor",
"path": "ImagingStudy.series.performer.actor",
"short": "Who performed the series",
"definition": "Indicates who or what performed the series.",
"min": 1,
"max": "1",
"base": {
"path": "ImagingStudy.series.performer.actor",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"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": "*",
"base": {
"path": "ImagingStudy.series.instance",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false,
"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"
}
],
"isModifier": false,
"isSummary": false,
"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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingStudy.series.instance.identifier",
"path": "ImagingStudy.series.instance.identifier",
"short": "Formal DICOM identifier for this instance",
"definition": "Formal identifier for this image or other content.",
"requirements": "DICOM Instance UID.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"base": {
"path": "ImagingStudy.series.instance.identifier",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"example": [
{
"label": "General",
"valueIdentifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903"
}
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"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",
"base": {
"path": "ImagingStudy.series.instance.number",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"example": [
{
"label": "General",
"valueUnsignedInt": 1
}
],
"isModifier": false,
"isSummary": false,
"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",
"base": {
"path": "ImagingStudy.series.instance.sopClass",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "sopClass"
}
],
"strength": "extensible",
"description": "The sopClass for the instance",
"valueSetCanonical": "http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1"
},
"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.",
"comment": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"min": 0,
"max": "1",
"base": {
"path": "ImagingStudy.series.instance.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"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": "workflow",
"map": "Event"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14-1"
}
]
},
{
"id": "ImagingStudy.identifier",
"path": "ImagingStudy.identifier",
"short": "Identifiers for the whole study",
"definition": "DICOM Study Instance UID, and Accession Number.",
"requirements": "UID would be encoded using FHIR OID encoding recommendation. Study Instance UID is indicated with use of \"official\", accession with use of \"secondary\".",
"alias": [
"StudyInstanceUID",
"AccessionNumber"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id and .inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "dicom",
"map": "(0020,0010)+(0020,000D)+(0008,0050)+(0008,0050)"
}
]
},
{
"id": "ImagingStudy.status",
"path": "ImagingStudy.status",
"short": "registered | available | cancelled | entered-in-error | unknown",
"definition": "The current state of the ImagingStudy.",
"comment": "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingStudyStatus"
}
],
"strength": "required",
"description": "The status of the ImagingStudy",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/imagingstudy-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "Varies by domain"
},
{
"identity": "rim",
"map": ".status"
}
]
},
{
"id": "ImagingStudy.modality",
"path": "ImagingStudy.modality",
"short": "All series modality if actual acquisition modalities",
"definition": "A list of all the series.modality 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": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
}
],
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetCanonical": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "(0008,0061)"
}
]
},
{
"id": "ImagingStudy.subject",
"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.subject",
"short": "Who or what is the subject of the study",
"definition": "The subject, typically a patient, of the imaging study.",
"comment": "QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Group"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "(0010/*)"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "ImagingStudy.context",
"path": "ImagingStudy.context",
"short": "Originating context",
"definition": "The encounter or episode at which the request is initiated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"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": "workflow",
"map": "Event.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.init"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0008,0020)+(0008,0030)"
}
]
},
{
"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/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/Appointment",
"http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"http://hl7.org/fhir/StructureDefinition/Task"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.basedOn"
},
{
"identity": "w5",
"map": "FiveWs.cause"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
},
{
"identity": "dicom",
"map": "(0032,1064)"
}
]
},
{
"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": "w5",
"map": "FiveWs.cause"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
},
{
"identity": "dicom",
"map": "(0008,0090)+(0008,0096)"
}
]
},
{
"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": "w5",
"map": "FiveWs.witness"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0008,1060)"
}
]
},
{
"id": "ImagingStudy.endpoint",
"path": "ImagingStudy.endpoint",
"short": "Study access endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.",
"comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.",
"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": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"id": "ImagingStudy.numberOfSeries",
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series",
"definition": "Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 0,
"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. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 0,
"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.procedureReference",
"path": "ImagingStudy.procedureReference",
"short": "The performed Procedure reference",
"definition": "A reference to the performed Procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Procedure"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.partOf"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "(0008,1032)"
}
]
},
{
"id": "ImagingStudy.procedureCode",
"path": "ImagingStudy.procedureCode",
"short": "The performed procedure code",
"definition": "The code for the performed procedure type.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingProcedureCode"
}
],
"strength": "extensible",
"description": "The performed procedure type",
"valueSetCanonical": "http://www.rsna.org/RadLex_Playbook.aspx"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "(0008,0032)"
}
]
},
{
"id": "ImagingStudy.location",
"path": "ImagingStudy.location",
"short": "Where ImagingStudy occurred",
"definition": "The principal physical location where the ImagingStudy was performed.",
"requirements": "Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Location"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.location"
},
{
"identity": "w5",
"map": "FiveWs.where[x]"
},
{
"identity": "v2",
"map": "EVN.7"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
},
{
"identity": "dicom",
"map": "(0008,1040)+(0040,0243)"
}
]
},
{
"id": "ImagingStudy.reasonCode",
"path": "ImagingStudy.reasonCode",
"short": "Why the study was requested",
"definition": "Description of clinical condition indicating why the ImagingStudy was requested.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingReason"
}
],
"strength": "example",
"description": "The reason for the study",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/procedure-reason"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "ImagingStudy.reasonReference",
"path": "ImagingStudy.reasonReference",
"short": "Why was study performed",
"definition": "Indicates another resource whose existence justifies this Study.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Media",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "v2",
"map": "EVN.4 or by domain"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"id": "ImagingStudy.note",
"path": "ImagingStudy.note",
"short": "Institution-generated description",
"definition": "Institution-generated description or classification of the Study performed.",
"requirements": "Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0008,1030)+(0040,0280)"
}
]
},
{
"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.identifier",
"path": "ImagingStudy.series.identifier",
"short": "Formal DICOM identifier for this series",
"definition": "Formal identifier for this series.",
"requirements": "DICOM Series UID.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"example": [
{
"label": "General",
"valueIdentifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
}
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"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": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
}
],
"strength": "extensible",
"description": "Type of acquired data in the instance",
"valueSetCanonical": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html"
},
"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 the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 0,
"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.endpoint",
"path": "ImagingStudy.series.endpoint",
"short": "Series access endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.",
"comment": "Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.",
"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": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"id": "ImagingStudy.series.bodySite",
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined",
"definition": "The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
}
],
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality.",
"valueSetCanonical": "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": "The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Laterality"
}
],
"strength": "example",
"description": "Codes describing body site laterality (left, right, etc.).",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/bodysite-laterality"
},
"mapping": [
{
"identity": "rim",
"map": ".targetSiteCode"
},
{
"identity": "dicom",
"map": "(0020,0060)"
}
]
},
{
"id": "ImagingStudy.series.specimen",
"path": "ImagingStudy.series.specimen",
"short": "Specimen imaged",
"definition": "The specimen imaged, e.g., for whole slide imaging of a biopsy.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Specimen"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
},
{
"identity": "dicom",
"map": "(0040,0551) + (0040,0562)"
}
]
},
{
"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.performer",
"path": "ImagingStudy.series.performer",
"short": "Who performed the series",
"definition": "Indicates who or what performed the series and how they were involved.",
"comment": "If the person who performed the series is not known, their Organization may be recorded. A patient, or related person, may be the performer, e.g. for patient-captured images.",
"requirements": "The performer is recorded at the series level, since each series in a study may be performed by a different performer, at different times, and using different devices. A series may be performed by multiple performers.",
"alias": [
"PerformingPhysicianName",
"OperatorName"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0008,1050) | (0008,1072)"
}
]
},
{
"id": "ImagingStudy.series.performer.function",
"path": "ImagingStudy.series.performer.function",
"short": "Type of performance",
"definition": "Distinguishes the type of involvement of the performer in the series.",
"requirements": "Allows disambiguation of the types of involvement of different performers.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventPerformerFunction"
}
],
"strength": "required",
"description": "The type of involvement of the performer",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/series-performer-function"
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
}
]
},
{
"id": "ImagingStudy.series.performer.actor",
"path": "ImagingStudy.series.performer.actor",
"short": "Who performed the series",
"definition": "Indicates who or what performed the series.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "v2",
"map": "EVN.5 or by domain"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"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.identifier",
"path": "ImagingStudy.series.instance.identifier",
"short": "Formal DICOM identifier for this instance",
"definition": "Formal identifier for this image or other content.",
"requirements": "DICOM Instance UID.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"example": [
{
"label": "General",
"valueIdentifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903"
}
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"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": "Coding"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "sopClass"
}
],
"strength": "extensible",
"description": "The sopClass for the instance",
"valueSetCanonical": "http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1"
},
"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.",
"comment": "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 Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:15+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change