US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

: US Core Requestor (Client) - JSON Representation

Page standards status: Trial-use Maturity Level: 3

Raw json | Download

{
  "resourceType" : "ActorDefinition",
  "id" : "us-core-client-actor",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ActorDefinition us-core-client-actor</b></p><a name=\"us-core-client-actor\"> </a><a name=\"hcus-core-client-actor\"> </a><table class=\"grid\"><tr><td><b>Actor: USCoreClientActor </b></td><td>US Core Requestor (Client)</td><td>Type: system </td></tr><tr><td colspan=\"3\"><div><p>The requirements this actor is expected to meet are listed in the <a href=\"Requirements-us-core-client.html\">US Core Client Requirements</a>. The <a href=\"CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatement</a> declares the RESTful interactions, profiles, and search parameters a US Core Requestor supports.</p>\n</div></td></tr><tr><td>References:</td><td colspan=\"2\"><a href=\"https://hl7.org/fhir/us/core/index.html#us-core-requestor\">https://hl7.org/fhir/us/core/index.html#us-core-requestor</a></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cgp"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 3,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/core/ActorDefinition/us-core-client-actor",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.2.12.4"
    }
  ],
  "version" : "10.0.0-ballot",
  "name" : "USCoreClientActor",
  "title" : "US Core Requestor (Client)",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-10-30T00:39:37+00:00",
  "publisher" : "HL7 International / Cross-Group Projects",
  "contact" : [
    {
      "name" : "HL7 International / Cross-Group Projects",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        },
        {
          "system" : "email",
          "value" : "cgp@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "A US Core Requestor is an application that initiates a data access request to retrieve patient data. The US Core Requestor is the Client in a Client-Server interaction. The terms \"US Core Requestor\" and \"Client\" are used interchangeably throughout this guide and are not meant to limit this actor to only patient and provider applications. For example, payers and other users can use the same technology. These terms are a short-hand notation for \"user application\".",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "type" : "system",
  "documentation" : "The requirements this actor is expected to meet are listed in the [US Core Client Requirements](Requirements-us-core-client.html). The [US Core Client CapabilityStatement](CapabilityStatement-us-core-client.html) declares the RESTful interactions, profiles, and search parameters a US Core Requestor supports.",
  "reference" : [
    "https://hl7.org/fhir/us/core/index.html#us-core-requestor"
  ]
}