Release 5 Ballot
DiagnosticsThis page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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 | Standards Status: Informative | Compartments: Patient |
This is a representation of the json schema for ImagingSelection, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/ImagingSelection",
"$ref": "#/definitions/ImagingSelection",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"ImagingSelection": {
"description": "A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.",
"properties": {
"resourceType": {
"description": "This is a ImagingSelection resource",
"const": "ImagingSelection"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "A unique identifier assigned to this imaging selection.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"subject": {
"description": "The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placed.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"issued": {
"description": "The date and time this imaging selection was created.",
"$ref": "#/definitions/instant"
},
"_issued": {
"description": "Extensions for issued",
"$ref": "Element.schema.json#/definitions/Element"
},
"performer": {
"description": "Selector of the instances – human or machine.",
"items": {
"$ref": "#/definitions/ImagingSelection_Performer"
},
"type": "array"
},
"basedOn": {
"description": "A list of the diagnostic requests that resulted in this imaging selection being performed.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"category": {
"description": "Classifies the imaging selection.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"code": {
"description": "Reason for referencing the selected content.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"studyUid": {
"description": "The Study Instance UID for the DICOM Study from which the images were selected.",
"$ref": "#/definitions/id"
},
"_studyUid": {
"description": "Extensions for studyUid",
"$ref": "Element.schema.json#/definitions/Element"
},
"derivedFrom": {
"description": "The imaging study from which the imaging selection is made.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"endpoint": {
"description": "The network service providing retrieval access to the selected images, frames, etc. See implementation notes for information about using DICOM endpoints.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"seriesUid": {
"description": "The Series Instance UID for the DICOM Series from which the images were selected.",
"$ref": "#/definitions/id"
},
"_seriesUid": {
"description": "Extensions for seriesUid",
"$ref": "Element.schema.json#/definitions/Element"
},
"seriesNumber": {
"description": "The Series Number for the DICOM Series from which the images were selected.",
"$ref": "#/definitions/unsignedInt"
},
"_seriesNumber": {
"description": "Extensions for seriesNumber",
"$ref": "Element.schema.json#/definitions/Element"
},
"frameOfReferenceUid": {
"description": "The Frame of Reference UID identifying the coordinate system that conveys spatial and/or temporal information for the selected images or frames.",
"$ref": "#/definitions/id"
},
"_frameOfReferenceUid": {
"description": "Extensions for frameOfReferenceUid",
"$ref": "Element.schema.json#/definitions/Element"
},
"bodySite": {
"description": "The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"focus": {
"description": "The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother\u0027s record. The focus of an observation could also be an existing condition, an intervention, the subject\u0027s diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child\u0027s tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"instance": {
"description": "Each imaging selection includes one or more selected DICOM SOP instances.",
"items": {
"$ref": "#/definitions/ImagingSelection_Instance"
},
"type": "array"
},
"imageRegion": {
"description": "Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.",
"items": {
"$ref": "#/definitions/ImagingSelection_ImageRegion1"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code",
"resourceType"
]
},
"ImagingSelection_Performer": {
"description": "A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Distinguishes the type of involvement of the performer.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"actor": {
"description": "Author – human or machine.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"ImagingSelection_Instance": {
"description": "A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"uid": {
"description": "The SOP Instance UID for the selected DICOM instance.",
"$ref": "#/definitions/id"
},
"_uid": {
"description": "Extensions for uid",
"$ref": "Element.schema.json#/definitions/Element"
},
"number": {
"description": "The Instance Number for the selected DICOM instance.",
"$ref": "#/definitions/unsignedInt"
},
"_number": {
"description": "Extensions for number",
"$ref": "Element.schema.json#/definitions/Element"
},
"sopClass": {
"description": "The SOP Class UID for the selected DICOM instance.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"subset": {
"description": "Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance.\n May be one of:\n - A list of frame numbers selected from a multiframe SOP Instance.\n - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance.\n - A list of segment numbers selected from a segmentation SOP Instance.\n - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_subset": {
"description": "Extensions for subset",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"imageRegion": {
"description": "Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates.\n If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.",
"items": {
"$ref": "#/definitions/ImagingSelection_ImageRegion"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ImagingSelection_ImageRegion": {
"description": "A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"regionType": {
"description": "Specifies the type of image region.",
"$ref": "#/definitions/code"
},
"_regionType": {
"description": "Extensions for regionType",
"$ref": "Element.schema.json#/definitions/Element"
},
"coordinate": {
"description": "The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution.\n The origin at the TLHC of the TLHC pixel is 0.0\\0.0, the BRHC of the TLHC pixel is 1.0\\1.0, and the BRHC of the BRHC pixel is the number of columns\\rows in the image / frames. The values must be within the range 0\\0 to the number of columns\\rows in the image / frames.",
"items": {
"$ref": "#/definitions/decimal"
},
"type": "array"
},
"_coordinate": {
"description": "Extensions for coordinate",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ImagingSelection_ImageRegion1": {
"description": "A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"regionType": {
"description": "Specifies the type of image region.",
"$ref": "#/definitions/code"
},
"_regionType": {
"description": "Extensions for regionType",
"$ref": "Element.schema.json#/definitions/Element"
},
"coordinate": {
"description": "The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and may be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid element.",
"items": {
"$ref": "#/definitions/decimal"
},
"type": "array"
},
"_coordinate": {
"description": "Extensions for coordinate",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 05:03+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change