SMART Health Cards and Links FHIR IG
1.0.0-ballot - STU1 Ballot International flag

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

: Issue Verifiable Credential - XML Representation

Draft as of 2021-03-08

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="patient-i-health-cards-issue"/>
  <text>
    <status value="generated"/>
    <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>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/smart-health-cards-and-links/OperationDefinition/patient-i-health-cards-issue"/>
  <version value="1.0.0-ballot"/>
  <name value="HealthCardsIssue"/>
  <title value="Issue Verifiable Credential"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2021-03-08"/>
  <publisher value="HL7 International / FHIR Infrastructure"/>
  <contact>
    <name value="HL7 International / FHIR Infrastructure"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <contact>
    <name value="Frank McKinney"/>
    <telecom>
      <system value="email"/>
      <value value="frank.mckinney@pocp.com"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fm@frankmckinney.com"/>
    </telecom>
  </contact>
  <description
               value="This operation enables a FHIR-enabled issuer to request or generate a specific type of SMART Health Card"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="health-cards-issue"/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="credentialType"/>
    <use value="in"/>
    <min value="1"/>
    <max value="*"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="credentialValueSet"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="includeIdentityClaim"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_since"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="verifiableCredential"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="resourceLink"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <part>
      <name value="vcIndex"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <type value="integer"/>
    </part>
    <part>
      <name value="bundledResource"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <type value="uri"/>
    </part>
    <part>
      <name value="hostedResource"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <type value="uri"/>
    </part>
  </parameter>
</OperationDefinition>