This page is part of the SMART Health Cards and Links FHIR IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Issue Verifiable Credential - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "patient-i-health-cards-issue",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition patient-i-health-cards-issue</b></p><a name=\"patient-i-health-cards-issue\"> </a><a name=\"hcpatient-i-health-cards-issue\"> </a><a name=\"patient-i-health-cards-issue-en-US\"> </a><p>URL: [base]/Patient/[id]/$health-cards-issue</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>credentialType</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td/></tr><tr><td>IN</td><td>credentialValueSet</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td/></tr><tr><td>IN</td><td>includeIdentityClaim</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>IN</td><td>_since</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td/></tr><tr><td>OUT</td><td>verifiableCredential</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>OUT</td><td>resourceLink</td><td/><td>0..*</td><td></td><td/><td/></tr><tr><td>OUT</td><td>resourceLink.vcIndex</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td/></tr><tr><td>OUT</td><td>resourceLink.bundledResource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td/></tr><tr><td>OUT</td><td>resourceLink.hostedResource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td/></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/smart-health-cards-and-links/OperationDefinition/patient-i-health-cards-issue",
  "version" : "1.0.0-ballot",
  "name" : "HealthCardsIssue",
  "title" : "Issue Verifiable Credential",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2021-03-08",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [
    {
      "name" : "HL7 International / FHIR Infrastructure",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name" : "Frank McKinney",
      "telecom" : [
        {
          "system" : "email",
          "value" : "frank.mckinney@pocp.com"
        },
        {
          "system" : "email",
          "value" : "fm@frankmckinney.com"
        }
      ]
    }
  ],
  "description" : "This operation enables a FHIR-enabled issuer to request or generate a specific type of SMART Health Card",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "health-cards-issue",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "credentialType",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "type" : "uri"
    },
    {
      "name" : "credentialValueSet",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "type" : "uri"
    },
    {
      "name" : "includeIdentityClaim",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "type" : "string"
    },
    {
      "name" : "_since",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "dateTime"
    },
    {
      "name" : "verifiableCredential",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "type" : "string"
    },
    {
      "name" : "resourceLink",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "part" : [
        {
          "name" : "vcIndex",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "type" : "integer"
        },
        {
          "name" : "bundledResource",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "uri"
        },
        {
          "name" : "hostedResource",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "uri"
        }
      ]
    }
  ]
}