{
"description": "Base StructureDefinition for ImagingExcerpt Resource",
"_filename": "imagingexcerpt.profile.json",
"requirements": "A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances.",
"package_name": "hl7.fhir.core",
"date": "2016-03-31T08:01:25+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"publisher": "Health Level Seven International (Imaging Integration)",
"fhirVersion": "1.4.0",
"name": "ImagingExcerpt",
"mapping": [ {
"uri": "http://nema.org/dicom",
"name": "DICOM",
"identity": "dicom"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM",
"identity": "rim"
} ],
"baseType": "DomainResource",
"abstract": false,
"type": null,
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.4.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
} ],
"snapshot": {
"element": [ {
"max": "*",
"min": 0,
"path": "ImagingExcerpt",
"type": [ {
"code": "DomainResource"
} ],
"alias": [ "Manifest", "XDS-I summary", "Key Images", "KOS" ],
"short": "Key Object Selection",
"mapping": [ {
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)",
"identity": "dicom"
}, {
"map": "clinical.diagnostics",
"identity": "w5"
} ],
"definition": "A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingExcerpt resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); a multi-frame ultrasound instance (\"cine\" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on."
}, {
"path": "ImagingExcerpt.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"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.",
"type": [ {
"code": "id"
} ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Resource.meta"
},
"path": "ImagingExcerpt.meta",
"type": [ {
"code": "Meta"
} ],
"short": "Metadata about the resource",
"isSummary": true,
"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."
}, {
"path": "ImagingExcerpt.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"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.",
"type": [ {
"code": "uri"
} ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "ImagingExcerpt.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "ImagingExcerpt.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"condition": [ "dom-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "ImagingExcerpt.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "ImagingExcerpt.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "ImagingExcerpt.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "ImagingExcerpt.uid",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"min": 1,
"definition": "Unique identifier of the DICOM Key Object Selection (KOS) representation.",
"short": "Instance UID",
"mapping": [ {
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)",
"identity": "dicom"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPInstanceUID" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.patient",
"requirements": "SOP Instances in ImagingExcerpt must be from the same patient.",
"min": 1,
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.",
"short": "Patient of the selected objects",
"comments": "SOP instances selected in the ImagingExcerpt can be from different studies, but must be of the same patient.",
"mapping": [ {
"map": "(0010,0010) - Patient Name (0010,0020) - Patient ID (0010,0021) - Issuer of Patient ID",
"identity": "dicom"
}, {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ]
} ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.authoringTime",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"min": 0,
"definition": "Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).",
"short": "Time when the imaging object selection was created",
"mapping": [ {
"map": "(0040,A032) - Observation Date Time",
"identity": "dicom"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "ObservationDateTime" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.author",
"requirements": "Track the selection decision maker.",
"min": 0,
"definition": "Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.",
"short": "Author (human or machine)",
"mapping": [ {
"map": "(0040,A730) - Content Sequence TID 1002 - Observer Context",
"identity": "dicom"
}, {
"map": "who.author",
"identity": "w5"
} ],
"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" ]
} ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.title",
"requirements": "Need to represent the application purpose that the SOP instances in ImagingExcerpt are selected for.",
"min": 1,
"definition": "The reason for, or significance of, the selection of objects referenced in the resource.",
"short": "Reason for selection",
"comments": "Coded concept of kind of the ImagingExcerpt. Value set is defined in the DICOM standard Part 16, CID-7010.",
"mapping": [ {
"map": "(0040,A043) - Concept Name Code Sequence in the SR root item",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"description": "The document title code of key object selection",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/kos-title"
}
},
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.description",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"min": 0,
"definition": "Text description of the DICOM SOP instances selected in the ImagingExcerpt. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.",
"short": "Description text",
"comments": "Free text narrative description of the ImagingExcerpt.",
"mapping": [ {
"map": "(0040,A160) - Text Value SR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "TextValue" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.study",
"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,
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"short": "Study identity of the selected instances",
"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.",
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Study"
} ],
"max": "*",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ImagingExcerpt.study.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ImagingExcerpt.study.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "ImagingExcerpt.study.uid",
"requirements": "Study instance UID is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"definition": "Study instance UID of the SOP instances in the selection.",
"short": "Study instance UID",
"mapping": [ {
"map": "(0020,000D) - Study Instance UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "StudyInstanceUID", "Referenced study instance UID" ],
"max": "1",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.imagingStudy",
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/StructureDefinition/ImagingStudy" ]
} ],
"short": "Reference to ImagingStudy",
"isSummary": true,
"definition": "Reference to the Imaging Study in FHIR form.",
"requirements": "Used to retrieve the ImagingStudy that contain the images referenced in the Imaging ObjectSelection.study."
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.dicom",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Dicom web access",
"comments": "Access method for applications that understand the DICOM web protocols for higher fidelity access.",
"definition": "Methods of accessing using DICOM web technologies.",
"requirements": "access methods available using DICOM web protocols."
}, {
"path": "ImagingExcerpt.study.dicom.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ImagingExcerpt.study.dicom.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ImagingExcerpt.study.dicom.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.dicom.type",
"type": [ {
"code": "code"
} ],
"short": "WADO-RS | WADO-URI | IID | WADO-WS",
"binding": {
"strength": "required",
"description": "The type of DICOM web technology available",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
},
"definition": "Access type for DICOM web."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.dicom.url",
"type": [ {
"code": "uri"
} ],
"short": "Retrieve study URL",
"definition": "The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol.",
"requirements": "URL enables retrieval of the entire study using DICOM Web API."
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.viewable",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Viewable format",
"definition": "A set of viewable reference images of various types.",
"requirements": "Accessible viewable forms that can be directly pulled and displayed without knowing DICOM Web protocols."
}, {
"path": "ImagingExcerpt.study.viewable.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ImagingExcerpt.study.viewable.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ImagingExcerpt.study.viewable.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "ImagingExcerpt.study.viewable.contentType",
"exampleCode": "text/plain; charset=UTF-8, image/png",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"max": "1"
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.height",
"type": [ {
"code": "positiveInt"
} ],
"short": "Height of the image in pixels (photo/video)",
"mapping": [ {
"map": "0028,0010",
"identity": "dicom"
} ],
"definition": "Height of the image in pixels (photo/video)."
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.width",
"type": [ {
"code": "positiveInt"
} ],
"short": "Width of the image in pixels (photo/video)",
"mapping": [ {
"map": "0028,0011",
"identity": "dicom"
} ],
"definition": "Width of the image in pixels (photo/video)."
}, {
"path": "ImagingExcerpt.study.viewable.frames",
"requirements": "If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"min": 0,
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif.",
"short": "Number of frames if > 1 (photo)",
"comments": "No relationship to the DICOM frame concept.",
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"defaultValueInteger": 1
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.duration",
"type": [ {
"code": "unsignedInt"
} ],
"short": "Length in seconds (audio / video)",
"mapping": [ {
"map": "~0028,0002",
"identity": "dicom"
} ],
"definition": "The duration of the recording in seconds - for audio and video."
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.size",
"type": [ {
"code": "unsignedInt"
} ],
"short": "Number of bytes of content (if url provided)",
"comments": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"definition": "The number of bytes of data that make up this attachment.",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all."
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.title",
"type": [ {
"code": "string"
} ],
"short": "Label to display in place of the data",
"definition": "A label or set of text to display in place of the data.",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"exampleString": "Official Corporate Logo"
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.viewable.url",
"type": [ {
"code": "uri"
} ],
"short": "Uri where the data can be found",
"definition": "A location where the data can be accessed.",
"exampleUri": "http://www.acme.com/logo-small.png",
"requirements": "The data needs to be transmitted by reference."
}, {
"path": "ImagingExcerpt.study.series",
"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,
"definition": "Series identity and locating information of the DICOM SOP instances in the selection.",
"short": "Series identity of the selected instances",
"comments": "Series component represents the series level identity and locator information of the DICOM SOP instances in the selection.",
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Series"
} ],
"max": "*",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ImagingExcerpt.study.series.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ImagingExcerpt.study.series.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.uid",
"requirements": "Series instance UID is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"definition": "Series instance UID of the SOP instances in the selection.",
"short": "Series instance UID",
"mapping": [ {
"map": "(0020,000E) - Series Instance UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SeriesInstanceUID", "Referenced series instance UID" ],
"max": "1",
"isSummary": true
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.series.dicom",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Dicom web access",
"comments": "Access method for applications that understand the DICOM web protocols for higher fidelity access.",
"definition": "Methods of accessing using DICOM web technologies.",
"requirements": "access methods available using DICOM web protocols."
}, {
"path": "ImagingExcerpt.study.series.dicom.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ImagingExcerpt.study.series.dicom.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ImagingExcerpt.study.series.dicom.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.dicom.type",
"type": [ {
"code": "code"
} ],
"short": "WADO-RS | WADO-URI | IID | WADO-WS",
"binding": {
"strength": "required",
"description": "The type of DICOM web technology available",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
},
"definition": "Access type for DICOM web."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.dicom.url",
"type": [ {
"code": "uri"
} ],
"short": "Retrieve study URL",
"definition": "The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol.",
"requirements": "URL enables retrieval of the entire series using DICOM Web API."
}, {
"path": "ImagingExcerpt.study.series.instance",
"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,
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"short": "The selected instance",
"comments": "SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierachy.",
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Instance"
} ],
"max": "*",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.instance.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ImagingExcerpt.study.series.instance.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ImagingExcerpt.study.series.instance.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.instance.sopClass",
"requirements": "DICOM SOP instances can be an image or other data object. The SOP class UID provide the accurate information about what type the instance is.",
"min": 1,
"definition": "SOP class UID of the selected instance.",
"short": "SOP class UID of instance",
"comments": "SOP class UID identifies the type of the selected instances, e.g. CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"mapping": [ {
"map": "(0008,0016) SOP Class UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPClassUID" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.instance.uid",
"requirements": "SOP instance UID is required to fully identify the DICOM SOP instance in the selection.",
"min": 1,
"definition": "SOP Instance UID of the selected instance.",
"short": "Selected instance UID",
"comments": "SOP instance UID identifies the instance.",
"mapping": [ {
"map": "(0008,0018) - SOP Instance UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPInstanceUID", "Referenced SOP instance UID" ],
"max": "1",
"isSummary": true
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.series.instance.dicom",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Dicom web access",
"comments": "Access method for applications that understand the DICOM web protocols for higher fidelity access.",
"definition": "Methods of accessing using DICOM web technologies.",
"requirements": "access methods available using DICOM web protocols."
}, {
"path": "ImagingExcerpt.study.series.instance.dicom.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references).",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"base": {
"max": "*",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ImagingExcerpt.study.series.instance.dicom.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ImagingExcerpt.study.series.instance.dicom.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.instance.dicom.type",
"type": [ {
"code": "code"
} ],
"short": "WADO-RS | WADO-URI | IID | WADO-WS",
"binding": {
"strength": "required",
"description": "The type of DICOM web technology available",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
},
"definition": "Access type for DICOM web."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.instance.dicom.url",
"type": [ {
"code": "uri"
} ],
"short": "Retrieve study URL",
"definition": "The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol.",
"requirements": "URL enables retrieval of the entire series using DICOM Web API."
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.series.instance.frameNumbers",
"type": [ {
"code": "unsignedInt"
} ],
"short": "Frame reference number",
"comments": "This component may be used if the referenced image SOP Instance is a multi-frame image.",
"definition": "The specific frame reference within a multi-frame object.",
"requirements": "The specific set of frames referenced in this imaging object selection. The URL retrieves the pixel data, and is encapsulated in a multipart MIME response."
} ]
},
"status": "draft",
"id": "c84e3515-d14f-4116-a8b1-329b22eea177",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/ImagingExcerpt",
"version": null,
"differential": {
"element": [ {
"max": "*",
"min": 0,
"path": "ImagingExcerpt",
"type": [ {
"code": "DomainResource"
} ],
"alias": [ "Manifest", "XDS-I summary", "Key Images", "KOS" ],
"short": "Key Object Selection",
"mapping": [ {
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)",
"identity": "dicom"
}, {
"map": "clinical.diagnostics",
"identity": "w5"
} ],
"definition": "A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingExcerpt resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); a multi-frame ultrasound instance (\"cine\" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on."
}, {
"path": "ImagingExcerpt.uid",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"min": 1,
"definition": "Unique identifier of the DICOM Key Object Selection (KOS) representation.",
"short": "Instance UID",
"mapping": [ {
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)",
"identity": "dicom"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPInstanceUID" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.patient",
"requirements": "SOP Instances in ImagingExcerpt must be from the same patient.",
"min": 1,
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.",
"short": "Patient of the selected objects",
"comments": "SOP instances selected in the ImagingExcerpt can be from different studies, but must be of the same patient.",
"mapping": [ {
"map": "(0010,0010) - Patient Name (0010,0020) - Patient ID (0010,0021) - Issuer of Patient ID",
"identity": "dicom"
}, {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ]
} ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.authoringTime",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"min": 0,
"definition": "Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).",
"short": "Time when the imaging object selection was created",
"mapping": [ {
"map": "(0040,A032) - Observation Date Time",
"identity": "dicom"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "ObservationDateTime" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.author",
"requirements": "Track the selection decision maker.",
"min": 0,
"definition": "Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.",
"short": "Author (human or machine)",
"mapping": [ {
"map": "(0040,A730) - Content Sequence TID 1002 - Observer Context",
"identity": "dicom"
}, {
"map": "who.author",
"identity": "w5"
} ],
"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" ]
} ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.title",
"requirements": "Need to represent the application purpose that the SOP instances in ImagingExcerpt are selected for.",
"min": 1,
"definition": "The reason for, or significance of, the selection of objects referenced in the resource.",
"short": "Reason for selection",
"comments": "Coded concept of kind of the ImagingExcerpt. Value set is defined in the DICOM standard Part 16, CID-7010.",
"mapping": [ {
"map": "(0040,A043) - Concept Name Code Sequence in the SR root item",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"description": "The document title code of key object selection",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/kos-title"
}
},
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.description",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"min": 0,
"definition": "Text description of the DICOM SOP instances selected in the ImagingExcerpt. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.",
"short": "Description text",
"comments": "Free text narrative description of the ImagingExcerpt.",
"mapping": [ {
"map": "(0040,A160) - Text Value SR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "TextValue" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.study",
"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,
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"short": "Study identity of the selected instances",
"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.",
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Study"
} ],
"max": "*",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.uid",
"requirements": "Study instance UID is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"definition": "Study instance UID of the SOP instances in the selection.",
"short": "Study instance UID",
"mapping": [ {
"map": "(0020,000D) - Study Instance UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "StudyInstanceUID", "Referenced study instance UID" ],
"max": "1",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.imagingStudy",
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/StructureDefinition/ImagingStudy" ]
} ],
"short": "Reference to ImagingStudy",
"isSummary": true,
"definition": "Reference to the Imaging Study in FHIR form.",
"requirements": "Used to retrieve the ImagingStudy that contain the images referenced in the Imaging ObjectSelection.study."
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.dicom",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Dicom web access",
"comments": "Access method for applications that understand the DICOM web protocols for higher fidelity access.",
"definition": "Methods of accessing using DICOM web technologies.",
"requirements": "access methods available using DICOM web protocols."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.dicom.type",
"type": [ {
"code": "code"
} ],
"short": "WADO-RS | WADO-URI | IID | WADO-WS",
"binding": {
"strength": "required",
"description": "The type of DICOM web technology available",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
},
"definition": "Access type for DICOM web."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.dicom.url",
"type": [ {
"code": "uri"
} ],
"short": "Retrieve study URL",
"definition": "The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol.",
"requirements": "URL enables retrieval of the entire study using DICOM Web API."
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.viewable",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Viewable format",
"definition": "A set of viewable reference images of various types.",
"requirements": "Accessible viewable forms that can be directly pulled and displayed without knowing DICOM Web protocols."
}, {
"path": "ImagingExcerpt.study.viewable.contentType",
"exampleCode": "text/plain; charset=UTF-8, image/png",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"max": "1"
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.height",
"type": [ {
"code": "positiveInt"
} ],
"short": "Height of the image in pixels (photo/video)",
"mapping": [ {
"map": "0028,0010",
"identity": "dicom"
} ],
"definition": "Height of the image in pixels (photo/video)."
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.width",
"type": [ {
"code": "positiveInt"
} ],
"short": "Width of the image in pixels (photo/video)",
"mapping": [ {
"map": "0028,0011",
"identity": "dicom"
} ],
"definition": "Width of the image in pixels (photo/video)."
}, {
"path": "ImagingExcerpt.study.viewable.frames",
"requirements": "If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"min": 0,
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif.",
"short": "Number of frames if > 1 (photo)",
"comments": "No relationship to the DICOM frame concept.",
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"defaultValueInteger": 1
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.duration",
"type": [ {
"code": "unsignedInt"
} ],
"short": "Length in seconds (audio / video)",
"mapping": [ {
"map": "~0028,0002",
"identity": "dicom"
} ],
"definition": "The duration of the recording in seconds - for audio and video."
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.size",
"type": [ {
"code": "unsignedInt"
} ],
"short": "Number of bytes of content (if url provided)",
"comments": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"definition": "The number of bytes of data that make up this attachment.",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all."
}, {
"max": "1",
"min": 0,
"path": "ImagingExcerpt.study.viewable.title",
"type": [ {
"code": "string"
} ],
"short": "Label to display in place of the data",
"definition": "A label or set of text to display in place of the data.",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"exampleString": "Official Corporate Logo"
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.viewable.url",
"type": [ {
"code": "uri"
} ],
"short": "Uri where the data can be found",
"definition": "A location where the data can be accessed.",
"exampleUri": "http://www.acme.com/logo-small.png",
"requirements": "The data needs to be transmitted by reference."
}, {
"path": "ImagingExcerpt.study.series",
"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,
"definition": "Series identity and locating information of the DICOM SOP instances in the selection.",
"short": "Series identity of the selected instances",
"comments": "Series component represents the series level identity and locator information of the DICOM SOP instances in the selection.",
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Series"
} ],
"max": "*",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.uid",
"requirements": "Series instance UID is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"definition": "Series instance UID of the SOP instances in the selection.",
"short": "Series instance UID",
"mapping": [ {
"map": "(0020,000E) - Series Instance UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SeriesInstanceUID", "Referenced series instance UID" ],
"max": "1",
"isSummary": true
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.series.dicom",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Dicom web access",
"comments": "Access method for applications that understand the DICOM web protocols for higher fidelity access.",
"definition": "Methods of accessing using DICOM web technologies.",
"requirements": "access methods available using DICOM web protocols."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.dicom.type",
"type": [ {
"code": "code"
} ],
"short": "WADO-RS | WADO-URI | IID | WADO-WS",
"binding": {
"strength": "required",
"description": "The type of DICOM web technology available",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
},
"definition": "Access type for DICOM web."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.dicom.url",
"type": [ {
"code": "uri"
} ],
"short": "Retrieve study URL",
"definition": "The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol.",
"requirements": "URL enables retrieval of the entire series using DICOM Web API."
}, {
"path": "ImagingExcerpt.study.series.instance",
"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,
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"short": "The selected instance",
"comments": "SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierachy.",
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Instance"
} ],
"max": "*",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.instance.sopClass",
"requirements": "DICOM SOP instances can be an image or other data object. The SOP class UID provide the accurate information about what type the instance is.",
"min": 1,
"definition": "SOP class UID of the selected instance.",
"short": "SOP class UID of instance",
"comments": "SOP class UID identifies the type of the selected instances, e.g. CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"mapping": [ {
"map": "(0008,0016) SOP Class UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPClassUID" ],
"max": "1",
"isSummary": true
}, {
"path": "ImagingExcerpt.study.series.instance.uid",
"requirements": "SOP instance UID is required to fully identify the DICOM SOP instance in the selection.",
"min": 1,
"definition": "SOP Instance UID of the selected instance.",
"short": "Selected instance UID",
"comments": "SOP instance UID identifies the instance.",
"mapping": [ {
"map": "(0008,0018) - SOP Instance UID",
"identity": "dicom"
} ],
"type": [ {
"code": "oid"
} ],
"alias": [ "SOPInstanceUID", "Referenced SOP instance UID" ],
"max": "1",
"isSummary": true
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.series.instance.dicom",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Dicom web access",
"comments": "Access method for applications that understand the DICOM web protocols for higher fidelity access.",
"definition": "Methods of accessing using DICOM web technologies.",
"requirements": "access methods available using DICOM web protocols."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.instance.dicom.type",
"type": [ {
"code": "code"
} ],
"short": "WADO-RS | WADO-URI | IID | WADO-WS",
"binding": {
"strength": "required",
"description": "The type of DICOM web technology available",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dWebType"
}
},
"definition": "Access type for DICOM web."
}, {
"max": "1",
"min": 1,
"path": "ImagingExcerpt.study.series.instance.dicom.url",
"type": [ {
"code": "uri"
} ],
"short": "Retrieve study URL",
"definition": "The source system root URL / base URL, from which all content can be retrieved using the specified DICOM protocol.",
"requirements": "URL enables retrieval of the entire series using DICOM Web API."
}, {
"max": "*",
"min": 0,
"path": "ImagingExcerpt.study.series.instance.frameNumbers",
"type": [ {
"code": "unsignedInt"
} ],
"short": "Frame reference number",
"comments": "This component may be used if the referenced image SOP Instance is a multi-frame image.",
"definition": "The specific frame reference within a multi-frame object.",
"requirements": "The specific set of frames referenced in this imaging object selection. The URL retrieves the pixel data, and is encapsulated in a multipart MIME response."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "other"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/imagemgt/index.cfm",
"system": "other"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}