FHIR Release 3 (STU)
DiagnosticsThis page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Imaging Integration Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Patient, Practitioner, RelatedPerson |
StructureDefinition for imagingmanifest
{
"resourceType": "StructureDefinition",
"id": "ImagingManifest",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "ii"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ImagingManifest",
"name": "ImagingManifest",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (Imaging Integration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/imagemgt/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ImagingManifest Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM Tag Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "ImagingManifest",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ImagingManifest",
"path": "ImagingManifest",
"short": "Key Object Selection",
"definition": "A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.",
"alias": [
"Manifest",
"XDS-I summary",
"Key Images",
"(in limited use) Key Object Selection (KOS)"
],
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "ImagingManifest.id",
"path": "ImagingManifest.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ImagingManifest.meta",
"path": "ImagingManifest.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ImagingManifest.implicitRules",
"path": "ImagingManifest.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.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ImagingManifest.language",
"path": "ImagingManifest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ImagingManifest.text",
"path": "ImagingManifest.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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ImagingManifest.contained",
"path": "ImagingManifest.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingManifest.extension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingManifest.modifierExtension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingManifest.identifier",
"path": "ImagingManifest.identifier",
"short": "SOP Instance UID",
"definition": "Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"alias": [
"SOPInstanceUID"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingManifest.patient",
"path": "ImagingManifest.patient",
"short": "Patient of the selected objects",
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.",
"comment": "SOP instances selected in the ImagingManifest can be from different studies, but must be of the same patient.",
"requirements": "SOP Instances in ImagingManifest must be from the same patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "(0010,0010) - Patient Name (0010,0020) - Patient ID (0010,0021) - Issuer of Patient ID"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ImagingManifest.authoringTime",
"path": "ImagingManifest.authoringTime",
"short": "Time when the selection of instances was made",
"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).",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"alias": [
"ObservationDateTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0040,A032) - Observation Date Time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "ImagingManifest.author",
"path": "ImagingManifest.author",
"short": "Author (human or machine)",
"definition": "Author of ImagingManifest. 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.",
"requirements": "Track the selection decision maker.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0040,A730) - Content Sequence TID 1002 - Observer Context"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "ImagingManifest.description",
"path": "ImagingManifest.description",
"short": "Description text",
"definition": "Free text narrative description of the ImagingManifest. \nThe value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.",
"comment": "Free text narrative description of the ImagingManifest.",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"alias": [
"TextValue"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0040,A160) - Text Value SR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")"
}
]
},
{
"id": "ImagingManifest.study",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Study"
}
],
"path": "ImagingManifest.study",
"short": "Study identity of the selected instances",
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"comment": "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 hierarchical 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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
}
]
},
{
"id": "ImagingManifest.study.id",
"path": "ImagingManifest.study.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.extension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.modifierExtension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingManifest.study.uid",
"path": "ImagingManifest.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.",
"alias": [
"StudyInstanceUID",
"Referenced study instance UID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000D) - Study Instance UID"
}
]
},
{
"id": "ImagingManifest.study.imagingStudy",
"path": "ImagingManifest.study.imagingStudy",
"short": "Reference to ImagingStudy",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "dicom",
"map": "imagingStudy (0020,000D) - Study Instance UID"
}
]
},
{
"id": "ImagingManifest.study.endpoint",
"path": "ImagingManifest.study.endpoint",
"short": "Study access service endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.",
"requirements": "Access methods for viewing (e.g. IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Series"
}
],
"path": "ImagingManifest.study.series",
"short": "Series identity of the selected instances",
"definition": "Series identity and locating information of the DICOM SOP instances in the selection.",
"comment": "Series component represents the series level identity 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 provides a means of retrieving the entire series.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.id",
"path": "ImagingManifest.study.series.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.extension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.modifierExtension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingManifest.study.series.uid",
"path": "ImagingManifest.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.",
"alias": [
"SeriesInstanceUID",
"Referenced series instance UID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000E) - Series Instance UID"
}
]
},
{
"id": "ImagingManifest.study.series.endpoint",
"path": "ImagingManifest.study.series.endpoint",
"short": "Series access endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.",
"requirements": "Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.instance",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Instance"
}
],
"path": "ImagingManifest.study.series.instance",
"short": "The selected instance",
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"comment": "SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierarchy.",
"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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.instance.id",
"path": "ImagingManifest.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). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.instance.extension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.instance.modifierExtension",
"path": "ImagingManifest.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ImagingManifest.study.series.instance.sopClass",
"path": "ImagingManifest.study.series.instance.sopClass",
"short": "SOP class UID of instance",
"definition": "SOP class UID of the selected instance.",
"comment": "SOP class UID identifies the type of the selected instances, e.g. CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"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.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
},
{
"identity": "dicom",
"map": "(0008,0016) SOP Class UID"
}
]
},
{
"id": "ImagingManifest.study.series.instance.uid",
"path": "ImagingManifest.study.series.instance.uid",
"short": "Selected instance UID",
"definition": "SOP Instance UID of the selected instance.",
"comment": "SOP instance UID identifies the instance.",
"requirements": "SOP instance UID is required to fully identify the DICOM SOP instance in the selection.",
"alias": [
"SOPInstanceUID",
"Referenced SOP instance UID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ImagingManifest",
"path": "ImagingManifest",
"short": "Key Object Selection",
"definition": "A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.",
"alias": [
"Manifest",
"XDS-I summary",
"Key Images",
"(in limited use) Key Object Selection (KOS)"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)"
},
{
"identity": "w5",
"map": "clinical.diagnostics"
}
]
},
{
"id": "ImagingManifest.identifier",
"path": "ImagingManifest.identifier",
"short": "SOP Instance UID",
"definition": "Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"alias": [
"SOPInstanceUID"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ImagingManifest.patient",
"path": "ImagingManifest.patient",
"short": "Patient of the selected objects",
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.",
"comment": "SOP instances selected in the ImagingManifest can be from different studies, but must be of the same patient.",
"requirements": "SOP Instances in ImagingManifest must be from the same patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "(0010,0010) - Patient Name (0010,0020) - Patient ID (0010,0021) - Issuer of Patient ID"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "ImagingManifest.authoringTime",
"path": "ImagingManifest.authoringTime",
"short": "Time when the selection of instances was made",
"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).",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"alias": [
"ObservationDateTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "(0040,A032) - Observation Date Time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "ImagingManifest.author",
"path": "ImagingManifest.author",
"short": "Author (human or machine)",
"definition": "Author of ImagingManifest. 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.",
"requirements": "Track the selection decision maker.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "(0040,A730) - Content Sequence TID 1002 - Observer Context"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "ImagingManifest.description",
"path": "ImagingManifest.description",
"short": "Description text",
"definition": "Free text narrative description of the ImagingManifest. \nThe value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.",
"comment": "Free text narrative description of the ImagingManifest.",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"alias": [
"TextValue"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "(0040,A160) - Text Value SR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")"
}
]
},
{
"id": "ImagingManifest.study",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Study"
}
],
"path": "ImagingManifest.study",
"short": "Study identity of the selected instances",
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"comment": "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 hierarchical 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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
}
]
},
{
"id": "ImagingManifest.study.uid",
"path": "ImagingManifest.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.",
"alias": [
"StudyInstanceUID",
"Referenced study instance UID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000D) - Study Instance UID"
}
]
},
{
"id": "ImagingManifest.study.imagingStudy",
"path": "ImagingManifest.study.imagingStudy",
"short": "Reference to ImagingStudy",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "dicom",
"map": "imagingStudy (0020,000D) - Study Instance UID"
}
]
},
{
"id": "ImagingManifest.study.endpoint",
"path": "ImagingManifest.study.endpoint",
"short": "Study access service endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.",
"requirements": "Access methods for viewing (e.g. IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Series"
}
],
"path": "ImagingManifest.study.series",
"short": "Series identity of the selected instances",
"definition": "Series identity and locating information of the DICOM SOP instances in the selection.",
"comment": "Series component represents the series level identity 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 provides a means of retrieving the entire series.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.uid",
"path": "ImagingManifest.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.",
"alias": [
"SeriesInstanceUID",
"Referenced series instance UID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0020,000E) - Series Instance UID"
}
]
},
{
"id": "ImagingManifest.study.series.endpoint",
"path": "ImagingManifest.study.series.endpoint",
"short": "Series access endpoint",
"definition": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.",
"requirements": "Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.instance",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Instance"
}
],
"path": "ImagingManifest.study.series.instance",
"short": "The selected instance",
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"comment": "SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierarchy.",
"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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ImagingManifest.study.series.instance.sopClass",
"path": "ImagingManifest.study.series.instance.sopClass",
"short": "SOP class UID of instance",
"definition": "SOP class UID of the selected instance.",
"comment": "SOP class UID identifies the type of the selected instances, e.g. CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"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.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
},
{
"identity": "dicom",
"map": "(0008,0016) SOP Class UID"
}
]
},
{
"id": "ImagingManifest.study.series.instance.uid",
"path": "ImagingManifest.study.series.instance.uid",
"short": "Selected instance UID",
"definition": "SOP Instance UID of the selected instance.",
"comment": "SOP instance UID identifies the instance.",
"requirements": "SOP instance UID is required to fully identify the DICOM SOP instance in the selection.",
"alias": [
"SOPInstanceUID",
"Referenced SOP instance UID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID"
}
]
}
]
}
}
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 Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change