ResMed Core Implementation Guide
0.37.0 - ci-build International flag

ResMed Core Implementation Guide - Local Development build (v0.37.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Validate a resource - JSON Representation

Draft as of 2024-01-11

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "Resource-validate",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Resource/$validate</p><p>URL: [base]/Resource/[id]/$validate</p><p>Parameters</p><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>resource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Must be present for validation.</p>\n</div></td></tr><tr><td>IN</td><td>mode</td><td/><td>0..0</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"http://hl7.org/fhir/R4/valueset-resource-validation-mode.html\">ResourceValidationMode</a> (Required)</td><td><div><p>Default is 'no action'; (e.g. general validation)</p>\n</div></td></tr><tr><td>IN</td><td>profile</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>If a profile name is provided, then the resource is validated against this specific profile, overriding any profile specified in the resource parameter. This can be omitted if a profile has been specified in the resource itself. If the server cannot validate against profile, i.e. it is not a known profile, it SHALL return an error.</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/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>If the operation outcome does not list any errors, then this is an indication that either a create or update operation on the resource instance specified would be expected to succeed.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://resmed.com/fhir/core/OperationDefinition/Resource-validate",
  "version" : "0.37.0",
  "name" : "Validate",
  "title" : "Validate a resource",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2024-01-11T18:32:48+00:00",
  "publisher" : "ResMed Corp",
  "contact" : [
    {
      "name" : "ResMed Corp",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.resmed.com"
        },
        {
          "system" : "email",
          "value" : "atomteam-halifax@resmed.com"
        }
      ]
    }
  ],
  "description" : "The validate operation checks whether the attached content would be acceptable. The return from this operation is an [OperationOutcome](http://hl7.org/fhir/operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](http://hl7.org/fhir/validation.html) for further information.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "code" : "validate",
  "resource" : [
    "Resource"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "resource",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Must be present for validation.",
      "type" : "Resource"
    },
    {
      "name" : "mode",
      "use" : "in",
      "min" : 0,
      "max" : "0",
      "documentation" : "Default is 'no action'; (e.g. general validation)",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/resource-validation-mode"
      }
    },
    {
      "name" : "profile",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If a profile name is provided, then the resource is validated against this specific profile, overriding any profile specified in the resource parameter. This can be omitted if a profile has been specified in the resource itself. If the server cannot validate against profile, i.e. it is not a known profile, it SHALL return an error.",
      "type" : "uri"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "If the operation outcome does not list any errors, then this is an indication that either a create or update operation on the resource instance specified would be expected to succeed.",
      "type" : "OperationOutcome"
    }
  ]
}