VRIS - Viljatusravi infosüsteem
0.1.0 - draft Estonia flag

VRIS - Viljatusravi infosüsteem, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-vris/ and changes regularly. See the Directory of published versions

: $patient-observations operation - JSON Representation

Draft as of 2026-07-15

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "EEVRISPatientObservations",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition EEVRISPatientObservations</b></p><a name=\"EEVRISPatientObservations\"> </a><a name=\"hcEEVRISPatientObservations\"> </a><p>URL: [base]/Patient/$patient-observations</p><p>URL: [base]/Patient/[id]/$patient-observations</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-ee-vris-patient-universal.html\" title=\"https://fhir.ee/vris/StructureDefinition/ee-vris-patient-universal\">Patient: EE VRIS Patient</a>, <a href=\"https://fhir.ee/packages/mpi/1.5.0/site/StructureDefinition-ee-mpi-patient-verified.html\" title=\"https://fhir.ee/mpi/StructureDefinition/ee-mpi-patient-verified\">EE MPI Patient Verified</a>, <a href=\"https://fhir.ee/packages/mpi/1.5.0/site/StructureDefinition-ee-mpi-patient-unknown.html\" title=\"https://fhir.ee/mpi/StructureDefinition/ee-mpi-patient-unknown\">EE MPI Patient Unknown</a>)</td><td/><td><div><p>Reference to the patient whose observations are being requested. Required when invoked at type level; optional (implied) when invoked at instance level.</p>\n</div></td></tr><tr><td>IN</td><td>profile</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Filter results to include only Observations conforming to specified profile(s). Multiple profiles can be provided (OR condition).</p>\n</div></td></tr><tr><td>IN</td><td>category</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td/><td><div><p>Filter by Observation.category value(s) (e.g., laboratory, exam, procedure, social-history).</p>\n</div></td></tr><tr><td>IN</td><td>code</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td/><td><div><p>Filter by Observation.code value(s) (e.g., specific LOINC or SNOMED CT codes).</p>\n</div></td></tr><tr><td>IN</td><td>date-from</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Include only Observations with effective date on or after this date.</p>\n</div></td></tr><tr><td>IN</td><td>date-to</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Include only Observations with effective date on or before this date.</p>\n</div></td></tr><tr><td>IN</td><td>status</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td/><td><div><p>Filter by Observation.status (e.g., final, amended, corrected, cancelled).</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/bundle.html\">Bundle</a></td><td/><td><div><p>Bundle of type 'searchset' containing all matching Observation resources. Empty Bundle if patient has no observations.</p>\n</div></td></tr></table><div><p>This operation returns all Observation resources associated with a given patient, optionally filtered by profile, category, code, or effective date range.</p>\n</div></div>"
  },
  "url" : "https://fhir.ee/vris/OperationDefinition/patient-observations",
  "version" : "0.1.0",
  "name" : "PatientObservations",
  "title" : "$patient-observations operation",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : true,
  "date" : "2026-07-15",
  "publisher" : "TEHIK",
  "contact" : [
    {
      "name" : "TEHIK",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.tehik.ee"
        },
        {
          "system" : "email",
          "value" : "fhir@tehik.ee"
        }
      ]
    },
    {
      "name" : "TEHIK Andmekorraldus",
      "telecom" : [
        {
          "system" : "email",
          "value" : "andmekorraldus@tehik.ee",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "TEST Custom operation to retrieve all Observation resources for a specific patient in Estonian VRIS. Supports optional filtering by profile, category, code, and date range. (ee Operatioon kõikide Observation ressursside pärimiseks VRIS-ist. Tagastab Bundle'i kõikide Observationitega, kus subject viitab antud patsiendile.)",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "EE",
          "display" : "Estonia"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "patient-observations",
  "comment" : "This operation returns all Observation resources associated with a given patient, optionally filtered by profile, category, code, or effective date range.",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Reference to the patient whose observations are being requested. Required when invoked at type level; optional (implied) when invoked at instance level.",
      "type" : "Reference",
      "targetProfile" : [
        🔗 "https://fhir.ee/vris/StructureDefinition/ee-vris-patient-universal"🔗 ,
        "https://fhir.ee/mpi/StructureDefinition/ee-mpi-patient-verified"🔗 ,
        "https://fhir.ee/mpi/StructureDefinition/ee-mpi-patient-unknown"
      ]
    },
    {
      "name" : "profile",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter results to include only Observations conforming to specified profile(s). Multiple profiles can be provided (OR condition).",
      "type" : "canonical"
    },
    {
      "name" : "category",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter by Observation.category value(s) (e.g., laboratory, exam, procedure, social-history).",
      "type" : "CodeableConcept"
    },
    {
      "name" : "code",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter by Observation.code value(s) (e.g., specific LOINC or SNOMED CT codes).",
      "type" : "CodeableConcept"
    },
    {
      "name" : "date-from",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Include only Observations with effective date on or after this date.",
      "type" : "dateTime"
    },
    {
      "name" : "date-to",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Include only Observations with effective date on or before this date.",
      "type" : "dateTime"
    },
    {
      "name" : "status",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter by Observation.status (e.g., final, amended, corrected, cancelled).",
      "type" : "code"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Bundle of type 'searchset' containing all matching Observation resources. Empty Bundle if patient has no observations.",
      "type" : "Bundle"
    }
  ]
}