Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2025-04-17 |
{
"resourceType" : "OperationDefinition",
"id" : "ah-smart-health-cards",
"meta" : {
"source" : "athenacoreext"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ah-smart-health-cards</b></p><a name=\"ah-smart-health-cards\"> </a><a name=\"hcah-smart-health-cards\"> </a><a name=\"ah-smart-health-cards-en-US\"> </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\">Information Source: <a href=\"https://simplifier.net/resolve?scope=ig-athena-core@dev&canonical=https://fhir.athena.io/core/athenacoreext\">athenacoreext</a></p></div><p>URL: [base]/Patient/[id]/$health-cards-issue</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>credentialType</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>This parameter restricts the request by high-level categories based on FHIR Resource Types such as "Observation" or "Immunization".</p>\n</div></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><div><p>Restricts the request by FHIR content such as "any standardized vaccine code for mpox".</p>\n</div></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><div><p>By default, the issuer will decide which identity claims to include, based on profile-driven guidance. If the Health Wallet wants to fine-tune identity claims in the generated credentials, it can provide an explicit list of one or more includeIdentityClaims, which will limit the claims included in the VC.</p>\n</div></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><div><p>By default, the issuer will return Health Cards of any age. If the Health Wallet wants to request only cards pertaining to data since a specific point in time, it can provide a _since parameter with a valueDateTime.</p>\n</div></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><div><p>Verifiable Clinical Information, modeled in FHIR and presented in a form based on W3C Verifiable Credentials (VC).</p>\n</div></td></tr><tr><td>OUT</td><td>resourceLink</td><td/><td>1..*</td><td></td><td/><td><div><p>Captures the link between any number of hosted FHIR resources and their derived representations within the verifiable credential's, allowing the health wallet to explicitly understand these correspondences between bundledResource and hostedResource, without baking details about the hosted endpoint into the signed credential.</p>\n</div></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><p>This OperationDefinition is based on the unofficial definition found at https://spec.smarthealth.cards/artifacts/operation-patient-i-health-cards-issue.json.</p>\n</div></div>"
},
"url" : "https://fhir.athena.io/OperationDefinition/ah-smart-health-cards",
"version" : "4.2.0",
"name" : "AthenahealthSmartHealthCards",
"title" : "athenahealth SMART Health Cards",
"status" : "draft",
"kind" : "operation",
"date" : "2025-04-17T16:42:09+00:00",
"publisher" : "athenahealth",
"contact" : [
{
"name" : "FHIR Enablement Team",
"telecom" : [
{
"system" : "email",
"value" : "mailto:fhir-enablement@athenahealth.com"
}
]
}
],
"description" : "The definition for the $health-cards-issue operation. This operation is an implementation of Health Cards based on the the SMART Health Cards specification https://spec.smarthealth.cards/",
"code" : "health-cards-issue",
"comment" : "This OperationDefinition is based on the unofficial definition found at https://spec.smarthealth.cards/artifacts/operation-patient-i-health-cards-issue.json.",
"resource" : [
"Patient"
],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [
{
"name" : "credentialType",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "This parameter restricts the request by high-level categories based on FHIR Resource Types such as \"Observation\" or \"Immunization\".",
"type" : "uri"
},
{
"name" : "credentialValueSet",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Restricts the request by FHIR content such as \"any standardized vaccine code for mpox\".",
"type" : "uri"
},
{
"name" : "includeIdentityClaim",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "By default, the issuer will decide which identity claims to include, based on profile-driven guidance. If the Health Wallet wants to fine-tune identity claims in the generated credentials, it can provide an explicit list of one or more includeIdentityClaims, which will limit the claims included in the VC.",
"type" : "string"
},
{
"name" : "_since",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "By default, the issuer will return Health Cards of any age. If the Health Wallet wants to request only cards pertaining to data since a specific point in time, it can provide a _since parameter with a valueDateTime.",
"type" : "dateTime"
},
{
"name" : "verifiableCredential",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Verifiable Clinical Information, modeled in FHIR and presented in a form based on W3C Verifiable Credentials (VC).",
"type" : "string"
},
{
"name" : "resourceLink",
"use" : "out",
"min" : 1,
"max" : "*",
"documentation" : "Captures the link between any number of hosted FHIR resources and their derived representations within the verifiable credential's, allowing the health wallet to explicitly understand these correspondences between bundledResource and hostedResource, without baking details about the hosted endpoint into the signed credential.",
"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"
}
]
}
]
}