10.5.10 JSON Schema for ImagingSelection

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.",
          "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"
        },
        "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"
        },
        "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": "Author – human or machine.",
          "items": {
            "$ref": "#/definitions/ImagingSelection_Performer"
          },
          "type": "array"
        },
        "code": {
          "description": "Describes the imaging selection.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "studyUid": {
          "description": "The Study Instance UID for the DICOM Study from which the images were selected.",
          "$ref": "#/definitions/oid"
        },
        "_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/oid"
        },
        "_seriesUid": {
          "description": "Extensions for seriesUid",
          "$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/oid"
        },
        "_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": "Coding.schema.json#/definitions/Coding"
        },
        "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 one or more image regions. Image regions are specified by a region type and a set of 2D or 3D coordinates.",
          "$ref": "#/definitions/ImagingSelection_ImageRegion"
        }
      },
      "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"
        }
      },
      "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/oid"
        },
        "_uid": {
          "description": "Extensions for uid",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "sopClass": {
          "description": "The SOP Class UID for the selected DICOM instance.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "frameList": {
          "description": "The set of frames within a multi-frame SOP Instance that are included in the imaging selection.       Encoded as a comma separated list of one or more non duplicate frame numbers.       If this is absent, all frames within the referenced SOP Instance are included in the selection.",
          "$ref": "#/definitions/string"
        },
        "_frameList": {
          "description": "Extensions for frameList",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "observationUid": {
          "description": "The unique identifier for the observation Content Item (and its subsidiary Content Items, if any) that are included in the imaging selection.",
          "items": {
            "$ref": "#/definitions/oid"
          },
          "type": "array"
        },
        "_observationUid": {
          "description": "Extensions for observationUid",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "segmentList": {
          "description": "The set of segments within a segmentation SOP Instance that are included in the imaging selection.       Encoded as a comma separated list of one or more non duplicate segment numbers.       If this is absent, all segments within the referenced segmentation SOP Instance are included in the selection.",
          "$ref": "#/definitions/string"
        },
        "_segmentList": {
          "description": "Extensions for segmentList",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "roiList": {
          "description": "The set of regions of interest (ROI) within a radiotherapy structure set instance that are included in the imaging selection.       Encoded as a comma separated list of one or more non duplicate ROI numbers.       If this is absent, all ROIs within the referenced radiotherapy structure set SOP Instance are included in the selection.",
          "$ref": "#/definitions/string"
        },
        "_roiList": {
          "description": "Extensions for roiList",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "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"
        },
        "coordinateType": {
          "description": "Specifies the type of coordinate system that define the image region.",
          "$ref": "#/definitions/code"
        },
        "_coordinateType": {
          "description": "Extensions for coordinateType",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "coordinates": {
          "description": "The coordinates describing the image region.       If coordinateType is 2D this specifies sequence of (x,y) coordinates in the coordinate system of the image specified by the instance.uid element that contains this image region.       If coordinateType is 3D this specifies sequence of (x,y,z) coordinates in the coordinate system specified by the frameOfReferenceUid element.",
          "items": {
            "$ref": "#/definitions/decimal"
          },
          "type": "array"
        },
        "_coordinates": {
          "description": "Extensions for coordinates",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    }
  }
}