Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

: Shareable OperationDefinition Example - JSON Representation

Page standards status: Informative

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "shareable-example",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableoperationdefinition"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition shareable-example</b></p><a name=\"shareable-example\"> </a><a name=\"hcshareable-example\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-crmi-shareableoperationdefinition.html\">CRMI Shareable OperationDefinition</a></p></div><p>URL: [base]/Questionnaire/[id]/$populate</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>subject</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>The resource that is to be the <em>QuestionnaireResponse.subject</em>. The <a href=\"http://hl7.org/fhir/R4/questionnaireresponse.html#QuestionnaireResponse\">QuestionnaireResponse</a>      instance will reference the provided subject.  In addition, if the <em>local</em> parameter is      set to true, server information about the specified subject will be used to populate the      instance.</p>\n</div></td></tr><tr><td>IN</td><td>local</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>If the <em>local</em> parameter is set to true, server information about the specified subject will be used to populate the instance.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/questionnaireresponse.html\">QuestionnaireResponse</a></td><td/><td><div><p>The partially (or fully)-populated set of answers for the specified Questionnaire</p>\n</div></td></tr></table><div><p>Only implemented for Labs and Medications so far</p>\n</div></div>"
  },
  "url" : "http://h7.org/fhir/uv/crmi/OperationDefinition/shareable-example",
  "version" : "B",
  "name" : "ShareableOperationDefinitionExample",
  "title" : "Shareable OperationDefinition Example",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : true,
  "date" : "2015-08-04",
  "publisher" : "Acme Healthcare Services",
  "contact" : [
    {
      "name" : "System Administrator",
      "telecom" : [
        {
          "system" : "email",
          "value" : "beep@coyote.acme.com"
        }
      ]
    }
  ],
  "description" : "Limited implementation of the Populate Questionnaire implementation",
  "useContext" : [
    {
      "code" : {
        "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code" : "venue",
        "display" : "Clinical Venue"
      },
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
            "code" : "IMP",
            "display" : "inpatient encounter"
          }
        ]
      }
    }
  ],
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "GB",
          "display" : "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "code" : "populate",
  "comment" : "Only implemented for Labs and Medications so far",
  "resource" : [
    "Questionnaire"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "subject",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The resource that is to be the *QuestionnaireResponse.subject*. The [[[QuestionnaireResponse]]]      instance will reference the provided subject.  In addition, if the *local* parameter is      set to true, server information about the specified subject will be used to populate the      instance.",
      "type" : "Reference"
    },
    {
      "name" : "local",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance.",
      "type" : "Reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The partially (or fully)-populated set of answers for the specified Questionnaire",
      "type" : "QuestionnaireResponse"
    }
  ],
  "overload" : [
    {
      "parameterName" : [
        "subject",
        "local"
      ]
    },
    {
      "parameterName" : [
        "subject"
      ],
      "comment" : "local defaults to false when not passed as a parameter"
    }
  ]
}