eHealth Infrastructure
2022.2 - release

eHealth Infrastructure - Local Development build (v2022.2). See the Directory of published versions

: Is context allowed - JSON Representation

Active as of 2022-06-20

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "EpisodeOfCare-i-is-context-allowed",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>is-context-allowed</h2><p>OPERATION: is-context-allowed</p><p>The official URL for this operation definition is: </p><pre>https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/EpisodeOfCare-i-is-context-allowed</pre><div><p>Checks that it is allowed to set an EpisodeOfCare as context.\nIf the user requesting context is a patient, then the patient input parameter should be specified.\nIf the user requesting context is a practitioner, then the careTeam input parameter should be specified.\nThrows an exception if it is not allowed to select the Episode Of Care context.</p>\n<h2>Output</h2>\n<p>For valid Episode of Care is returned references that cause the Episode of Care to be valid context.\nFor a practitioner, two output parameters will be returned on success:</p>\n<ul>\n<li>CareTeam: The Careteam that gave access</li>\n<li>EpisodeOfCare/CarePlan: The EpisodeOfCare or CarePlan that referenced the CareTeam</li>\n</ul>\n</div><p>URL: [base]/EpisodeOfCare/[id]/$is-context-allowed</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</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>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td/></tr><tr><td>IN</td><td>careTeam</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td/></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters</a></td><td/><td/></tr></table></div>"
  },
  "url" : "https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/EpisodeOfCare-i-is-context-allowed",
  "version" : "2022.2",
  "name" : "is-context-allowed",
  "title" : "Is context allowed",
  "status" : "active",
  "kind" : "operation",
  "date" : "2022-06-20T13:22:29+00:00",
  "publisher" : "Systematic | Trifork",
  "contact" : [
    {
      "name" : "Systematic | Trifork",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "description" : "Checks that it is allowed to set an EpisodeOfCare as context.\r\nIf the user requesting context is a patient, then the patient input parameter should be specified.\r\nIf the user requesting context is a practitioner, then the careTeam input parameter should be specified.\r\nThrows an exception if it is not allowed to select the Episode Of Care context.\r\n## Output\r\nFor valid Episode of Care is returned references that cause the Episode of Care to be valid context. \r\nFor a practitioner, two output parameters will be returned on success:\r\n- CareTeam: The Careteam that gave access\r\n- EpisodeOfCare/CarePlan: The EpisodeOfCare or CarePlan that referenced the CareTeam",
  "affectsState" : false,
  "code" : "is-context-allowed",
  "resource" : [
    "EpisodeOfCare"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Reference"
    },
    {
      "name" : "careTeam",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "type" : "Parameters"
    }
  ]
}