Documentation Index
Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
Use this file to discover all available pages before exploring further.
Properties
| Name | Required | Type | Description |
|---|
| identifier | No | Identifier[] | Identifiers for the whole study |
| status | Yes | code | registered / available / cancelled / entered-in-error / unknown |
| modality | No | Coding[] | All series modality if actual acquisition modalities |
| subject | Yes | Reference<Patient / Device / Group> | Who or what is the subject of the study |
| encounter | No | Reference<Encounter> | Encounter with which this imaging study is associated |
| started | No | dateTime | When the study was started |
| basedOn | No | Reference<CarePlan / ServiceRequest / Appointment / AppointmentResponse / Task>[] | Request fulfilled |
| referrer | No | Reference<Practitioner / PractitionerRole> | Referring physician |
| interpreter | No | Reference<Practitioner / PractitionerRole>[] | Who interpreted images |
| endpoint | No | Reference<Endpoint>[] | Study access endpoint |
| numberOfSeries | No | unsignedInt | Number of Study Related Series |
| numberOfInstances | No | unsignedInt | Number of Study Related Instances |
| procedureReference | No | Reference<Procedure> | The performed Procedure reference |
| procedureCode | No | CodeableConcept[] | The performed procedure code |
| location | No | Reference<Location> | Where ImagingStudy occurred |
| reasonCode | No | CodeableConcept[] | Why the study was requested |
| reasonReference | No | Reference<Condition / Observation / Media / DiagnosticReport / DocumentReference>[] | Why was study performed |
| note | No | Annotation[] | User-defined comments |
| description | No | string | Institution-generated description |
| series | No | ImagingStudySeries | Each study has one or more series of instances |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - uid | Yes | id | DICOM Series Instance UID for the series |
| - number | No | unsignedInt | Numeric identifier of this series |
| - modality | Yes | Coding | The modality of the instances in the series |
| - description | No | string | A short human readable summary of the series |
| - numberOfInstances | No | unsignedInt | Number of Series Related Instances |
| - endpoint | No | Reference<Endpoint>[] | Series access endpoint |
| - bodySite | No | Coding | Body part examined |
| - laterality | No | Coding | Body part laterality |
| - specimen | No | Reference<Specimen>[] | Specimen imaged |
| - started | No | dateTime | When the series started |
| - performer | No | ImagingStudySeriesPerformer | Who performed the series |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - function | No | CodeableConcept | Type of performance |
| - actor | Yes | Reference<Practitioner / PractitionerRole / Organization / CareTeam / Patient / Device / RelatedPerson> | Who performed the series |
| - instance | No | ImagingStudySeriesInstance | A single SOP instance from the series |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - uid | Yes | id | DICOM SOP Instance UID |
| - sopClass | Yes | Coding | DICOM class type |
| - number | No | unsignedInt | The number of this instance in the series |
| - title | No | string | Description of instance |
Search Parameters
| Name | Type | Description | Expression |
|---|
| identifier | token | Identifiers for the Study, such as DICOM Study Instance UID and Accession number | ImagingStudy.identifier |
| patient | reference | Who the study is about | ImagingStudy.subject |
| basedon | reference | The order for the image | ImagingStudy.basedOn |
| bodysite | token | The body site studied | ImagingStudy.series.bodySite |
| dicom-class | token | The type of the instance | ImagingStudy.series.instance.sopClass |
| encounter | reference | The context of the study | ImagingStudy.encounter |
| endpoint | reference | The endpoint for the study or series | ImagingStudy.endpoint |
| instance | token | SOP Instance UID for an instance | ImagingStudy.series.instance.uid |
| interpreter | reference | Who interpreted the images | ImagingStudy.interpreter |
| modality | token | The modality of the series | ImagingStudy.series.modality |
| performer | reference | The person who performed the study | ImagingStudy.series.performer.actor |
| reason | token | The reason for the study | ImagingStudy.reasonCode |
| referrer | reference | The referring physician | ImagingStudy.referrer |
| series | token | DICOM Series Instance UID for a series | ImagingStudy.series.uid |
| started | date | When the study was started | ImagingStudy.started |
| status | token | The status of the study | ImagingStudy.status |
| subject | reference | Who the study is about | ImagingStudy.subject |
Inherited Properties
| Name | Required | Type | Description |
|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
