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 
StructureDefinition for imagingobjectselection
{
"resourceType": "StructureDefinition",
"id": "ImagingObjectSelection",
"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/ImagingObjectSelection",
"name": "ImagingObjectSelection",
"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 ImagingObjectSelection 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": "ImagingObjectSelection",
"short": "Key Object Selection",
"definition": "A set of DICOM SOP Instances of a patient, selected for some application purpose, e.g., quality assurance, teaching, conference, consulting, etc. Objects selected can be from different studies, but must be of the same patient.",
"requirements": "A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances.",
"alias": [
"ImageManifest\nKeyImageNote"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)"
}
]
},
{
"path": "ImagingObjectSelection.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": "ImagingObjectSelection.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": "ImagingObjectSelection.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": "ImagingObjectSelection.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": "ImagingObjectSelection.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": "ImagingObjectSelection.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": "ImagingObjectSelection.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": "ImagingObjectSelection.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": "ImagingObjectSelection.uid",
"short": "Instance UID",
"definition": "Instance UID of the DICOM KOS SOP Instances represenetd in this resource.",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingObjectSelection.patient",
"short": "Patient of the selected objects",
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selection.",
"comments": "SOP instances selected in the key object selection can be from different studies, but must be of the same patient.",
"requirements": "SOP Instances in key object selection must be from the same patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0010,0010) - Patient Name\n(0010,0020) - Patient ID\n(0010,0021) - Issuer of Patient ID"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingObjectSelection.title",
"short": "Reason for selection",
"definition": "The reason for, or significance of, the selection of objects referenced in the resource.",
"comments": "Coded concept of kind of the key object selection. Value set is defined in the DICOM standard CID-7010.\n\nhttp://medical.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html.",
"requirements": "Need to represent the application purpose that the SOP instances in key object selection are selected for.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "KOStitle",
"strength": "example",
"description": "The document title code of key object selection",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/kos-title"
}
},
"mapping": [
{
"identity": "dicom",
"map": "(0040,A043) - Concept Name Code Sequence in the SR root item"
}
]
},
{
"path": "ImagingObjectSelection.description",
"short": "Description text",
"definition": "Text description of the DICOM SOP instances selected in the key object selection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.",
"comments": "Free text narrative description of the key object selection.",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A160) - Text Value\nSR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")"
}
]
},
{
"path": "ImagingObjectSelection.author",
"short": "Author (human or machine)",
"definition": "Author of key object selection. It can be a human authtor or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attached in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.",
"comments": "Author of the key object selection. This can be a human author or a device author. Human author is represented with the HumanName type. Device author is represented with a reference to the Device resource.",
"requirements": "Track the selection decision maker.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A730) - Content Sequence\nTID 1002 - Observer Context"
}
]
},
{
"path": "ImagingObjectSelection.authoringTime",
"short": "Authoring time of the selection",
"definition": "Date and time when the key object selection was authored. Note that this is the date and time the DICOM SOP instances in the selection were selected (selection decision making). It is different from the creation date and time of the selection resource.",
"comments": "Authoring time.",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A032) - Observation Date Time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingObjectSelection.study",
"short": "Study identity of the selected instances",
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"comments": "Study component represents the study level identity and locator information of the DICOM SOP instances in the selection. It is the top level identity of the hierachical identification of the instances.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.uid",
"short": "Study instance uid",
"definition": "Study instance uid of the SOP instances in the selection.",
"requirements": "Study instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000D) - Study Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection.",
"comments": "Study level locator information is optional. If provided, this is the URL to retrieve the entire study with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire study using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series",
"short": "Series identity of the selected instances",
"definition": "Series indetity and locating information of the DICOM SOP instances in the selection.",
"comments": "Series component represents the series level indentity and locator information of the DICOM SOP instances in the selection.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provide a means of retrieving the entire series.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.series.uid",
"short": "Series instance uid",
"definition": "Series instance uid of the SOP instances in the selection.",
"requirements": "Series instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000E) - Series Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selection.",
"comments": "Series level locator information is optional. If provided, this is the URL to retrieve the entire series with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire series using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance",
"short": "The selected instance",
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"comments": "SOP Instance component identify the instance selected in the selection, along with the study and series identities to form the DICOM identity hierachy.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.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": "ImagingObjectSelection.study.series.instance.sopClass",
"short": "SOP class uid of instance",
"definition": "SOP class uid of the selected instance.",
"comments": "SOP class uid provides the type of the selected instances, e.g., CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"requirements": "DICOM SOP instance can be an imaging or other data object. The SOP class uid provide the accurate information about what type the instance is.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0016) SOP Class UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.uid",
"short": "Uid of the selected instance",
"definition": "SOP Instance uid of the selected instance.",
"comments": "SOP instance uid identifies the instance.",
"requirements": "SOP instance uid is required to fully identify the DICOM SOP instance in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM SOP Instance.",
"comments": "Instance level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the SOP instance using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames",
"short": "The frame set",
"definition": "Identity and location information of the frames in the selected instance.",
"comments": "This component may be used if the referenced image SOP Instance is a multi-frame image.",
"requirements": "The DICOM frames for a given study, series, SOP Instance UID, and frame numbers. The retrieveUrl retrieves the pixel data, and is encapsulated in a multipart MIME response.",
"min": 0,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.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": "ImagingObjectSelection.study.series.instance.frames.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": "ImagingObjectSelection.study.series.instance.frames.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": "ImagingObjectSelection.study.series.instance.frames.frameNumbers",
"short": "Frame numbers",
"definition": "The frame numbers in the frame set.",
"requirements": "one or more non duplicate frame numbers.",
"min": 1,
"max": "*",
"type": [
{
"code": "unsignedInt"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM frames.",
"comments": "Frame level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the frames using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "WADO-RS - RetrieveFrames"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ImagingObjectSelection",
"short": "Key Object Selection",
"definition": "A set of DICOM SOP Instances of a patient, selected for some application purpose, e.g., quality assurance, teaching, conference, consulting, etc. Objects selected can be from different studies, but must be of the same patient.",
"requirements": "A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances.",
"alias": [
"ImageManifest\nKeyImageNote"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)"
}
]
},
{
"path": "ImagingObjectSelection.uid",
"short": "Instance UID",
"definition": "Instance UID of the DICOM KOS SOP Instances represenetd in this resource.",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingObjectSelection.patient",
"short": "Patient of the selected objects",
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selection.",
"comments": "SOP instances selected in the key object selection can be from different studies, but must be of the same patient.",
"requirements": "SOP Instances in key object selection must be from the same patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0010,0010) - Patient Name\n(0010,0020) - Patient ID\n(0010,0021) - Issuer of Patient ID"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingObjectSelection.title",
"short": "Reason for selection",
"definition": "The reason for, or significance of, the selection of objects referenced in the resource.",
"comments": "Coded concept of kind of the key object selection. Value set is defined in the DICOM standard CID-7010.\n\nhttp://medical.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html.",
"requirements": "Need to represent the application purpose that the SOP instances in key object selection are selected for.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "KOStitle",
"strength": "example",
"description": "The document title code of key object selection",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/kos-title"
}
},
"mapping": [
{
"identity": "dicom",
"map": "(0040,A043) - Concept Name Code Sequence in the SR root item"
}
]
},
{
"path": "ImagingObjectSelection.description",
"short": "Description text",
"definition": "Text description of the DICOM SOP instances selected in the key object selection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.",
"comments": "Free text narrative description of the key object selection.",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A160) - Text Value\nSR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")"
}
]
},
{
"path": "ImagingObjectSelection.author",
"short": "Author (human or machine)",
"definition": "Author of key object selection. It can be a human authtor or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attached in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.",
"comments": "Author of the key object selection. This can be a human author or a device author. Human author is represented with the HumanName type. Device author is represented with a reference to the Device resource.",
"requirements": "Track the selection decision maker.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A730) - Content Sequence\nTID 1002 - Observer Context"
}
]
},
{
"path": "ImagingObjectSelection.authoringTime",
"short": "Authoring time of the selection",
"definition": "Date and time when the key object selection was authored. Note that this is the date and time the DICOM SOP instances in the selection were selected (selection decision making). It is different from the creation date and time of the selection resource.",
"comments": "Authoring time.",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A032) - Observation Date Time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingObjectSelection.study",
"short": "Study identity of the selected instances",
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"comments": "Study component represents the study level identity and locator information of the DICOM SOP instances in the selection. It is the top level identity of the hierachical identification of the instances.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.uid",
"short": "Study instance uid",
"definition": "Study instance uid of the SOP instances in the selection.",
"requirements": "Study instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000D) - Study Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection.",
"comments": "Study level locator information is optional. If provided, this is the URL to retrieve the entire study with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire study using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series",
"short": "Series identity of the selected instances",
"definition": "Series indetity and locating information of the DICOM SOP instances in the selection.",
"comments": "Series component represents the series level indentity and locator information of the DICOM SOP instances in the selection.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provide a means of retrieving the entire series.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.uid",
"short": "Series instance uid",
"definition": "Series instance uid of the SOP instances in the selection.",
"requirements": "Series instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000E) - Series Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selection.",
"comments": "Series level locator information is optional. If provided, this is the URL to retrieve the entire series with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire series using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance",
"short": "The selected instance",
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"comments": "SOP Instance component identify the instance selected in the selection, along with the study and series identities to form the DICOM identity hierachy.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.instance.sopClass",
"short": "SOP class uid of instance",
"definition": "SOP class uid of the selected instance.",
"comments": "SOP class uid provides the type of the selected instances, e.g., CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"requirements": "DICOM SOP instance can be an imaging or other data object. The SOP class uid provide the accurate information about what type the instance is.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0016) SOP Class UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.uid",
"short": "Uid of the selected instance",
"definition": "SOP Instance uid of the selected instance.",
"comments": "SOP instance uid identifies the instance.",
"requirements": "SOP instance uid is required to fully identify the DICOM SOP instance in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM SOP Instance.",
"comments": "Instance level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the SOP instance using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames",
"short": "The frame set",
"definition": "Identity and location information of the frames in the selected instance.",
"comments": "This component may be used if the referenced image SOP Instance is a multi-frame image.",
"requirements": "The DICOM frames for a given study, series, SOP Instance UID, and frame numbers. The retrieveUrl retrieves the pixel data, and is encapsulated in a multipart MIME response.",
"min": 0,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.frameNumbers",
"short": "Frame numbers",
"definition": "The frame numbers in the frame set.",
"requirements": "one or more non duplicate frame numbers.",
"min": 1,
"max": "*",
"type": [
{
"code": "unsignedInt"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM frames.",
"comments": "Frame level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the frames using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "WADO-RS - RetrieveFrames"
}
]
}
]
}
}
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