Zus FHIR GraphQL Service
The Zus FHIR GraphQL service allows users to interactively retrieve structured health data for use in web and API applications.
For large-scale batch querying and analytics, Zus provides Data Mart services. Our solution engineers will be happy to work with you do choose the right service for your needs.
API Endpoints
https://api.zusapi.com/fqs/query
Version
beta
Getting started
Authentication
All requests to FQS require authentication.
FQS supports the same HTTP Authorization
token used througout Zus APIs. Queries are made using a POST request and a bearer token. See Authenticating for API Access for instructions on obtaining a bearer token.
POST /fqs/query HTTP/1.1
Host: api.zusapi.com/fqs/query
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Content-Type: application/json
Using HTTP 2:
POST /fqs/query HTTP/2
Host: api.zusapi.com/fqs/query
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
content-type: application/json
Find a patient
Find the FHIR resource iD of a Patient record, and make the following query in Postman (link TBD):
query {
Patient (id: $id) {
id
name { family given }
}
}
Data you are authorized to see
FQS is a read-only service. You are permitted to view data in the Zus platform that was either created directly by your organization, or is part of the Common Patient Record for a patient that your organization has a treatment relationship with.
To view data that created by your organization, perform builder-scoped searches. To view data in the Common Patient Record, perform patient-scoped searches.
Examples
Get a single resource by FHIR ID
query {
Patient (id: $id) {
id
name { family given }
// any other fields you want
}
}
A more detailed example
Expand
query {
Patient(id: "0098df9f-e41f-4ded-8fa3-bf9190a0db1d") {
address {
city
country
district
line
period {
start
end
}
postalCode
state
text
type
use
}
birthDate
contact {
relationship {
coding {
code
}
}
telecom {
system
use
value
}
}
deceasedBoolean
deceasedDateTime
gender
id
identifier {
system
value
}
maritalStatus {
coding {
code
}
text
}
managingOrganization {
reference
display
}
name {
family
given
period {
start
end
}
prefix
suffix
text
use
}
}
}
Search for Patients with a UPID
The List
query type allows you to retrieve the first n results. The first 10 results are returned by default.
query {
ConditionList (upid: $upid) {
id
meta { lastUpdated }
}
}
A more detailed example
Expand
{
PatientList(upid: "0468241e-220c-4fa8-bed2-15343430b27d") {
address {
city
country
district
line
period {
start
end
}
postalCode
state
text
type
use
}
birthDate
contact {
relationship {
coding {
code
}
}
telecom {
system
use
value
}
}
deceasedBoolean
deceasedDateTime
gender
id
identifier {
system
value
}
maritalStatus {
coding {
code
}
text
}
managingOrganization {
reference
display
}
name {
family
given
period {
start
end
}
prefix
suffix
text
use
}
}
}
Paginating through results
If you need to paginate through a large number of results, use the Connection
query type.
query {
ConditionConnection (
upid: $upid,
first: 100,
after: "",
filter: { clinicalStatus: { anymatch: "active" } }
) {
pageInfo {
hasNextPage
}
edges {
node {
id
meta { lastUpdated }
}
cursor
}
}
}
A more detailed example
Expand
query MedicationRequest {
MedicationRequestConnection(
upid: "4ed64962-9c8f-4712-9484-db6f85174817"
first: 100
) {
edges {
node {
resourceType
contained {
resource {
... on Medication {
id
resourceType
code {
coding {
extension {
url
valueString
}
system
code
display
userSelected
}
}
}
... on Organization {
id
resourceType
_organization__name: name
}
... on Practitioner {
id
resourceType
_practitioner__name: name {
family
given
prefix
suffix
}
}
}
}
meta {
id
versionId
lastUpdated
source
profile
security {
system
code
}
tag {
system
code
}
}
implicitRules
authoredOn
language
text {
id
div
}
identifier {
id
type {
coding {
system
code
display
}
}
system
value
period {
start
end
}
}
category {
coding {
system
code
display
}
}
medicationCodeableConcept {
coding {
extension {
url
valueString
}
system
code
display
userSelected
}
text
}
subject {
id
reference
type
identifier {
id
type {
coding {
system
code
display
}
}
system
value
period {
start
end
}
}
display
}
}
cursor
}
pageInfo {
hasNextPage
}
}
}
The response includes a value for cursor
. To get the next page of results, provide the after
parameter using the last cursor
in the last page.
query MedicationRequest {
MedicationRequestConnection(
upid: "4ed64962-9c8f-4712-9484-db6f85174817"
after: "f789c7f7-f706-4119-98ff-c23c578c10f1"
) {
edges {
node {
id
meta {
tag {
system
code
}
}
}
cursor
}
pageInfo {
hasNextPage
}
}
}
We currently have a partial implementation of the GraphQL Cursor Connections Specification. Forward pagination (with first
and after
) is supported, but reverse pagination (with last
and before
) has not been implemented.
Syntax overview
Query scopes
For HTTP requests, the POST body is passed as a JSON string:
{
"query": "<queryContent>",
"variables": {
"variable1": "value1"
}
}
<queryContent>
is a GraphQL query string:
query <queryName> {
<queryType> (<parameters) {
<fields>
}
}
<queryName>
is optional and allows you to identify your query.<queryType>
is one of the types below.<parameters>
varies by query type. There is always a required scope parameter (id
orupid
), and Connection query types support optional pagination, filter, and sort parameters.<fields>
varies by query type. See the documentation below for where to request specific FHIR fields.
Single resource
query [<name>] {
<resourceType> (id: $id) {
// FHIR fields
}
}
<resourceType>
is the FHIR resource type$id
(required) is the FHIR resource ID
Single resoure history
History queries return all versions of a single resource. Versions are sorted in ascending order.
query [<name>] {
<resourceType>History (id: $id) {
// FHIR fields
}
}
<resourceType>
is the FHIR resource type$id
(required) is the FHIR resource ID
Patient-scoped queries
List queries
query [<name>] {
<resourceType>List (upid: $upid) {
// FHIR fields
}
}
<resourceType>
is the FHIR resource type$upid
(required) is the patient UPID
Connection queries
query [<name>] {
<resourceType>Connection (upid: $upid, [<pagination>], [<sort>], [<filter>]) {
pageInfo {
hasNextPage
}
edges {
node {
// FHIR fields
}
cursor
}
}
}
<resourceType>
is the FHIR resource type$upid
(required) is the patient UPID<pagination>
(optional) can be any/all of the pagination parameters. See below for pagination parameter documentation.<sort>
(optional) is a field to sort by. See details below.<filter>
(optional) is an object of fields to filter by. See detials below.
Builder-scoped queries
Under construction
Filtering
Connection queries support a filter
argument to filter returned results. The filter
argument has the following form:
{
<searchTerm>: { <predicate>: <value> }
}
Valid values for <searchTerm>
depend on the resource type. All resource types support a <searchTerm>
of tag
and ids
. To look up what filter parameters are supported by each resource type, look for <resourceType>FilterParams
under the list of types.
Predicates
Valid values for <predicate>
and <value>
depends on the search term type.
All types
Predicate | Values | Description |
---|---|---|
missing |
true false |
Match resources that have or are missing this field |
Date
Predicate | Values | Description |
---|---|---|
gt |
"2023-03-21" "2022-06-23T22:08:41+00:00" |
Match resources with <searchTerm> after this date |
ge |
"2023-03-21" "2022-06-23T22:08:41+00:00" |
Match resources with <searchTerm> on or after this date |
eq |
"2023-03-21" "2022-06-23T22:08:41+00:00" |
Match resources with <searchTerm> on this date |
le |
"2023-03-21" "2022-06-23T22:08:41+00:00" |
Match resources with <searchTerm> on or before this date |
lt |
"2023-03-21" "2022-06-23T22:08:41+00:00" |
Match resources with <searchTerm> before this date |
String
Predicate | Values | Description |
---|---|---|
eq |
"active" |
Match resources where <searchTerm> is exactly this string |
startswith |
"act" |
Match resources where <searchTerm> starts with this string |
StringSet
Predicate | Values | Description |
---|---|---|
anymatch |
["active", "stopped"] |
Match resources where <searchTerm> includes any of these values |
allmatch |
["1234", "aspirin"] |
Match resources where <searchTerm> includes all of these values |
nonematch |
["surescripts", "quest"] |
Match resources where <searchTerm> includes none of these values |
Sorting
Connection queries support a sort
argument to sort returned results. The sort
argument has the following form:
{
<sortTerm>: <direction>
}
<direction>
is either "ASC"
for ascending or "DESC"
for descending.
Only one sort parameter may be specified at a time. All resource types can be sorted by lastUpdated
. To look up what sort parameters are supported by each resource type, look for <resourceType>SortParams
under the list of types.
Pagination
Valid pagination parameters:
first
: Page size to returnafter
: Return results after the specified cursor
References and contained resources
FHIR resources often contain a reference to another resource of a different type. To get fields from the referenced resource, use GraphQL fragments.
Example of getting a Patient's managingOrganization
query Patient {
Patient (id: "0a9f397d-1255-4f28-8f58-7ca0e6509e5b") {
id
meta {
lastUpdated
versionId
tag {
system
code
}
}
extension {
url
valueString
}
managingOrganization {
resource {
... on Organization {
id
name
}
}
}
}
}
FHIR resource types
FHIR resoure types
Resoruces in the designated record set (DRS)
The designated record set (DRS) covers the records that individuals have a right to request under the HIPAA Privacy Rule
Zus has mapped record types in the DRS to the following resources in the FHIR standard:
- Account
- AllergyIntolerance
- Appointment
- AppointmentResponse
- BodyStructure
- CarePlan
- CareTeam
- ClinicalImpression
- Composition
- Condition
- Consent
- Coverage
- CoverageEligibilityRequest
- CoverageEligibilityResponse
- DetectedIssue
- Device
- DeviceRequest
- DiagnosticReport
- DocumentManifest
- DocumentReference
- Encounter
- EpisodeOfCare
- FamilyMemberHistory
- Flag
- Goal
- ImagingStudy
- Immunization
- ImmunizationEvaluation
- ImmunizationRecommendation
- MeasureReport
- Media
- MedicationAdministration
- MedicationDispense
- MedicationRequest
- MedicationStatement
- MolecularSequence
- NutritionOrder
- Observation
- Patient
- Person
- Procedure
- Provenance
- RelatedPerson
- RiskAssessment
- ServiceRequest
- Specimen
- SupplyDelivery
- SupplyRequest
- VisionPrescription
FHIR resource types in the DRS can be queried using patient-scoped queries.
Foundational resources
Foundational resource types are FHIR resource types that represent entities in the health system. These records by themselves are not PHI, but are referenced by PHI as they are involved in patient treatment. Zus considers the following FHIR resource types to be Foundational:
- Location
- Medication
- Organization
- Practitioner
- PractitionerRole
Limitations and best practices
Superclusters (UPIDs with over 1000 resources for a single resource type) have poor query performance
Don't request fields than you don't need. Response latency is correlated with response size, and requesting too many fields increases the size of the response.
If you're trying to compute statistics, you should probably use the data lake/warehouse
Tech details
How is FQS related to GraphQL with FHIR?
The GraphQL schema on FQS was based on the draft GraphQL on FHIR spec, but we have chosen to diverge on several points:
- The query scopes for patient-centric and builder-centric queries are unique to Zus
- We do not suppress empty elements (the GraphQL documentation is ambiguous about this and it has caused confusion in the FHIR community)
- Pagination follows the GraphQL Cursor Connection spec rather than the Connection examples in the FHIR spec
- Instead of supporting FHIR search parameters, FQS search parameters are curated. We are using the Dgraph database syntax as inspiration for allowing richer combinations of filter parameters
- FQS supports fragment expansion of contained resources (but the client has to know in advance what resource type they want). The FHIR GraphQL spec expressly does not support _contained
- FQS supports sorting but the FHIR GraphQL spec does not mention it
How data gets in FQS
There are a number of ways data gets in the Zus ecosystem:
- Direct writes via API
- Third party data from patient history jobs
- Data arriving from third party subscriptions
- Derived data (Lenses) generated automatically by Zus
FQS is eventually consistent for all data input sources. Direct writes from input APIs typically arrive in FQS within a second. Derived data is typically updated within seconds. Data from patient history jobs arrive between a few minutes and 24 hours, depending on the data source. Data from third party subscriptions typically arrive in FQS within seconds from when it is received by Zus.
Queries
AllergyIntolerance
Response
Returns an AllergyIntolerance
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query AllergyIntolerance($id: ID!) {
AllergyIntolerance(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
clinicalStatus {
...CodeableConceptFragment
}
verificationStatus {
...CodeableConceptFragment
}
type
category
criticality
code {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
onsetDateTime
onsetAge {
...AgeFragment
}
onsetPeriod {
...PeriodFragment
}
onsetRange {
...RangeFragment
}
onsetString
recordedDate
recorder {
...ReferenceFragment
}
asserter {
...ReferenceFragment
}
lastOccurrence
note {
...AnnotationFragment
}
reaction {
...AllergyIntoleranceReactionFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"AllergyIntolerance": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"clinicalStatus": CodeableConcept,
"verificationStatus": CodeableConcept,
"type": "allergy",
"category": ["food"],
"criticality": "low",
"code": CodeableConcept,
"patient": Reference,
"encounter": Reference,
"onsetDateTime": "xyz789",
"onsetAge": Age,
"onsetPeriod": Period,
"onsetRange": Range,
"onsetString": "abc123",
"recordedDate": "abc123",
"recorder": Reference,
"asserter": Reference,
"lastOccurrence": "xyz789",
"note": [Annotation],
"reaction": [AllergyIntoleranceReaction]
}
}
}
AllergyIntoleranceConnection
Response
Returns an AllergyIntoleranceConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - AllergyIntoleranceFilterParams!
|
Default = {} |
sort - AllergyIntoleranceSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query AllergyIntoleranceConnection(
$upid: ID!,
$filter: AllergyIntoleranceFilterParams!,
$sort: AllergyIntoleranceSortParams!,
$first: Int!,
$after: String!
) {
AllergyIntoleranceConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...AllergyIntoleranceEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"AllergyIntoleranceConnection": {
"pageInfo": PageInfo,
"edges": [AllergyIntoleranceEdge]
}
}
}
AllergyIntoleranceHistory
Response
Returns [AllergyIntolerance!]
Example
Query
query AllergyIntoleranceHistory(
$id: ID!,
$count: Int!
) {
AllergyIntoleranceHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
clinicalStatus {
...CodeableConceptFragment
}
verificationStatus {
...CodeableConceptFragment
}
type
category
criticality
code {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
onsetDateTime
onsetAge {
...AgeFragment
}
onsetPeriod {
...PeriodFragment
}
onsetRange {
...RangeFragment
}
onsetString
recordedDate
recorder {
...ReferenceFragment
}
asserter {
...ReferenceFragment
}
lastOccurrence
note {
...AnnotationFragment
}
reaction {
...AllergyIntoleranceReactionFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"AllergyIntoleranceHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"clinicalStatus": CodeableConcept,
"verificationStatus": CodeableConcept,
"type": "allergy",
"category": ["food"],
"criticality": "low",
"code": CodeableConcept,
"patient": Reference,
"encounter": Reference,
"onsetDateTime": "xyz789",
"onsetAge": Age,
"onsetPeriod": Period,
"onsetRange": Range,
"onsetString": "xyz789",
"recordedDate": "abc123",
"recorder": Reference,
"asserter": Reference,
"lastOccurrence": "xyz789",
"note": [Annotation],
"reaction": [AllergyIntoleranceReaction]
}
]
}
}
AllergyIntoleranceList
Response
Returns [AllergyIntolerance!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - AllergyIntoleranceFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query AllergyIntoleranceList(
$upid: ID!,
$filter: AllergyIntoleranceFilterParams!,
$_count: Int!
) {
AllergyIntoleranceList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
clinicalStatus {
...CodeableConceptFragment
}
verificationStatus {
...CodeableConceptFragment
}
type
category
criticality
code {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
onsetDateTime
onsetAge {
...AgeFragment
}
onsetPeriod {
...PeriodFragment
}
onsetRange {
...RangeFragment
}
onsetString
recordedDate
recorder {
...ReferenceFragment
}
asserter {
...ReferenceFragment
}
lastOccurrence
note {
...AnnotationFragment
}
reaction {
...AllergyIntoleranceReactionFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"AllergyIntoleranceList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"clinicalStatus": CodeableConcept,
"verificationStatus": CodeableConcept,
"type": "allergy",
"category": ["food"],
"criticality": "low",
"code": CodeableConcept,
"patient": Reference,
"encounter": Reference,
"onsetDateTime": "abc123",
"onsetAge": Age,
"onsetPeriod": Period,
"onsetRange": Range,
"onsetString": "xyz789",
"recordedDate": "xyz789",
"recorder": Reference,
"asserter": Reference,
"lastOccurrence": "xyz789",
"note": [Annotation],
"reaction": [AllergyIntoleranceReaction]
}
]
}
}
Appointment
Response
Returns an Appointment
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query Appointment($id: ID!) {
Appointment(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
cancelationReason {
...CodeableConceptFragment
}
serviceCategory {
...CodeableConceptFragment
}
serviceType {
...CodeableConceptFragment
}
specialty {
...CodeableConceptFragment
}
appointmentType {
...CodeableConceptFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
priority
description
supportingInformation {
...ReferenceFragment
}
start
end
minutesDuration
slot {
...ReferenceFragment
}
created
comment
patientInstruction
basedOn {
...ReferenceFragment
}
participant {
...AppointmentParticipantFragment
}
requestedPeriod {
...PeriodFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"Appointment": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "proposed",
"cancelationReason": CodeableConcept,
"serviceCategory": [CodeableConcept],
"serviceType": [CodeableConcept],
"specialty": [CodeableConcept],
"appointmentType": CodeableConcept,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"priority": 123,
"description": "abc123",
"supportingInformation": [Reference],
"start": "xyz789",
"end": "abc123",
"minutesDuration": 123,
"slot": [Reference],
"created": "xyz789",
"comment": "xyz789",
"patientInstruction": "xyz789",
"basedOn": [Reference],
"participant": [AppointmentParticipant],
"requestedPeriod": [Period]
}
}
}
AppointmentConnection
Response
Returns an AppointmentConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - AppointmentFilterParams!
|
Default = {} |
sort - AppointmentSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query AppointmentConnection(
$upid: ID!,
$filter: AppointmentFilterParams!,
$sort: AppointmentSortParams!,
$first: Int!,
$after: String!
) {
AppointmentConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...AppointmentEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"AppointmentConnection": {
"pageInfo": PageInfo,
"edges": [AppointmentEdge]
}
}
}
AppointmentHistory
Response
Returns [Appointment!]
Example
Query
query AppointmentHistory(
$id: ID!,
$count: Int!
) {
AppointmentHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
cancelationReason {
...CodeableConceptFragment
}
serviceCategory {
...CodeableConceptFragment
}
serviceType {
...CodeableConceptFragment
}
specialty {
...CodeableConceptFragment
}
appointmentType {
...CodeableConceptFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
priority
description
supportingInformation {
...ReferenceFragment
}
start
end
minutesDuration
slot {
...ReferenceFragment
}
created
comment
patientInstruction
basedOn {
...ReferenceFragment
}
participant {
...AppointmentParticipantFragment
}
requestedPeriod {
...PeriodFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"AppointmentHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "proposed",
"cancelationReason": CodeableConcept,
"serviceCategory": [CodeableConcept],
"serviceType": [CodeableConcept],
"specialty": [CodeableConcept],
"appointmentType": CodeableConcept,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"priority": 987,
"description": "abc123",
"supportingInformation": [Reference],
"start": "abc123",
"end": "xyz789",
"minutesDuration": 987,
"slot": [Reference],
"created": "abc123",
"comment": "abc123",
"patientInstruction": "xyz789",
"basedOn": [Reference],
"participant": [AppointmentParticipant],
"requestedPeriod": [Period]
}
]
}
}
AppointmentList
Response
Returns [Appointment!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - AppointmentFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query AppointmentList(
$upid: ID!,
$filter: AppointmentFilterParams!,
$_count: Int!
) {
AppointmentList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
cancelationReason {
...CodeableConceptFragment
}
serviceCategory {
...CodeableConceptFragment
}
serviceType {
...CodeableConceptFragment
}
specialty {
...CodeableConceptFragment
}
appointmentType {
...CodeableConceptFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
priority
description
supportingInformation {
...ReferenceFragment
}
start
end
minutesDuration
slot {
...ReferenceFragment
}
created
comment
patientInstruction
basedOn {
...ReferenceFragment
}
participant {
...AppointmentParticipantFragment
}
requestedPeriod {
...PeriodFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"AppointmentList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "proposed",
"cancelationReason": CodeableConcept,
"serviceCategory": [CodeableConcept],
"serviceType": [CodeableConcept],
"specialty": [CodeableConcept],
"appointmentType": CodeableConcept,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"priority": 987,
"description": "xyz789",
"supportingInformation": [Reference],
"start": "xyz789",
"end": "xyz789",
"minutesDuration": 987,
"slot": [Reference],
"created": "abc123",
"comment": "abc123",
"patientInstruction": "xyz789",
"basedOn": [Reference],
"participant": [AppointmentParticipant],
"requestedPeriod": [Period]
}
]
}
}
Basic
Example
Query
query Basic($id: ID!) {
Basic(id: $id) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
code {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
created
author {
...ReferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"Basic": {
"resourceType": "xyz789",
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"code": CodeableConcept,
"subject": Reference,
"created": "abc123",
"author": Reference
}
}
}
BasicConnection
Response
Returns a BasicConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - BasicFilterParams!
|
Default = {} |
sort - BasicSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query BasicConnection(
$upid: ID!,
$filter: BasicFilterParams!,
$sort: BasicSortParams!,
$first: Int!,
$after: String!
) {
BasicConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...BasicEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"BasicConnection": {
"pageInfo": PageInfo,
"edges": [BasicEdge]
}
}
}
BasicHistory
Example
Query
query BasicHistory(
$id: ID!,
$count: Int!
) {
BasicHistory(
id: $id,
count: $count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
code {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
created
author {
...ReferenceFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"BasicHistory": [
{
"resourceType": "xyz789",
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"code": CodeableConcept,
"subject": Reference,
"created": "abc123",
"author": Reference
}
]
}
}
BasicList
Response
Returns [Basic!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - BasicFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query BasicList(
$upid: ID!,
$filter: BasicFilterParams!,
$_count: Int!
) {
BasicList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
code {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
created
author {
...ReferenceFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"BasicList": [
{
"resourceType": "xyz789",
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"code": CodeableConcept,
"subject": Reference,
"created": "xyz789",
"author": Reference
}
]
}
}
Binary
Example
Query
query Binary($id: ID!) {
Binary(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
contentType
securityContext {
...ReferenceFragment
}
data
}
}
Variables
{"id": 4}
Response
{
"data": {
"Binary": {
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"contentType": "xyz789",
"securityContext": Reference,
"data": "abc123"
}
}
}
BinaryConnection
Response
Returns a BinaryConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - BinaryFilterParams!
|
Default = {} |
sort - BinarySortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query BinaryConnection(
$upid: ID!,
$filter: BinaryFilterParams!,
$sort: BinarySortParams!,
$first: Int!,
$after: String!
) {
BinaryConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...BinaryEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"BinaryConnection": {
"pageInfo": PageInfo,
"edges": [BinaryEdge]
}
}
}
BinaryHistory
Example
Query
query BinaryHistory(
$id: ID!,
$count: Int!
) {
BinaryHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
contentType
securityContext {
...ReferenceFragment
}
data
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"BinaryHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"contentType": "xyz789",
"securityContext": Reference,
"data": "abc123"
}
]
}
}
BinaryList
Response
Returns [Binary!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - BinaryFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query BinaryList(
$upid: ID!,
$filter: BinaryFilterParams!,
$_count: Int!
) {
BinaryList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
contentType
securityContext {
...ReferenceFragment
}
data
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"BinaryList": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"contentType": "abc123",
"securityContext": Reference,
"data": "xyz789"
}
]
}
}
CarePlan
Example
Query
query CarePlan($id: ID!) {
CarePlan(id: $id) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiatesCanonical
instantiatesUri
basedOn {
...ReferenceFragment
}
replaces {
...ReferenceFragment
}
partOf {
...ReferenceFragment
}
status
intent
category {
...CodeableConceptFragment
}
title
description
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
period {
...PeriodFragment
}
created
author {
...ReferenceFragment
}
contributor {
...ReferenceFragment
}
careTeam {
...ReferenceFragment
}
addresses {
...ReferenceFragment
}
supportingInfo {
...ReferenceFragment
}
goal {
...ReferenceFragment
}
activity {
...CarePlanActivityFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"CarePlan": {
"resourceType": "abc123",
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiatesCanonical": ["xyz789"],
"instantiatesUri": ["abc123"],
"basedOn": [Reference],
"replaces": [Reference],
"partOf": [Reference],
"status": "draft",
"intent": "proposal",
"category": [CodeableConcept],
"title": "xyz789",
"description": "abc123",
"subject": Reference,
"encounter": Reference,
"period": Period,
"created": "abc123",
"author": Reference,
"contributor": [Reference],
"careTeam": [Reference],
"addresses": [Reference],
"supportingInfo": [Reference],
"goal": [Reference],
"activity": [CarePlanActivity],
"note": [Annotation]
}
}
}
CarePlanConnection
Response
Returns a CarePlanConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - CarePlanFilterParams!
|
Default = {} |
sort - CarePlanSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query CarePlanConnection(
$upid: ID!,
$filter: CarePlanFilterParams!,
$sort: CarePlanSortParams!,
$first: Int!,
$after: String!
) {
CarePlanConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CarePlanEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"CarePlanConnection": {
"pageInfo": PageInfo,
"edges": [CarePlanEdge]
}
}
}
CarePlanHistory
Response
Returns [CarePlan!]
Example
Query
query CarePlanHistory(
$id: ID!,
$count: Int!
) {
CarePlanHistory(
id: $id,
count: $count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiatesCanonical
instantiatesUri
basedOn {
...ReferenceFragment
}
replaces {
...ReferenceFragment
}
partOf {
...ReferenceFragment
}
status
intent
category {
...CodeableConceptFragment
}
title
description
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
period {
...PeriodFragment
}
created
author {
...ReferenceFragment
}
contributor {
...ReferenceFragment
}
careTeam {
...ReferenceFragment
}
addresses {
...ReferenceFragment
}
supportingInfo {
...ReferenceFragment
}
goal {
...ReferenceFragment
}
activity {
...CarePlanActivityFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"CarePlanHistory": [
{
"resourceType": "xyz789",
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiatesCanonical": ["abc123"],
"instantiatesUri": ["abc123"],
"basedOn": [Reference],
"replaces": [Reference],
"partOf": [Reference],
"status": "draft",
"intent": "proposal",
"category": [CodeableConcept],
"title": "xyz789",
"description": "xyz789",
"subject": Reference,
"encounter": Reference,
"period": Period,
"created": "abc123",
"author": Reference,
"contributor": [Reference],
"careTeam": [Reference],
"addresses": [Reference],
"supportingInfo": [Reference],
"goal": [Reference],
"activity": [CarePlanActivity],
"note": [Annotation]
}
]
}
}
CarePlanList
Response
Returns [CarePlan!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - CarePlanFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query CarePlanList(
$upid: ID!,
$filter: CarePlanFilterParams!,
$_count: Int!
) {
CarePlanList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiatesCanonical
instantiatesUri
basedOn {
...ReferenceFragment
}
replaces {
...ReferenceFragment
}
partOf {
...ReferenceFragment
}
status
intent
category {
...CodeableConceptFragment
}
title
description
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
period {
...PeriodFragment
}
created
author {
...ReferenceFragment
}
contributor {
...ReferenceFragment
}
careTeam {
...ReferenceFragment
}
addresses {
...ReferenceFragment
}
supportingInfo {
...ReferenceFragment
}
goal {
...ReferenceFragment
}
activity {
...CarePlanActivityFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"CarePlanList": [
{
"resourceType": "xyz789",
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiatesCanonical": ["abc123"],
"instantiatesUri": ["abc123"],
"basedOn": [Reference],
"replaces": [Reference],
"partOf": [Reference],
"status": "draft",
"intent": "proposal",
"category": [CodeableConcept],
"title": "abc123",
"description": "xyz789",
"subject": Reference,
"encounter": Reference,
"period": Period,
"created": "xyz789",
"author": Reference,
"contributor": [Reference],
"careTeam": [Reference],
"addresses": [Reference],
"supportingInfo": [Reference],
"goal": [Reference],
"activity": [CarePlanActivity],
"note": [Annotation]
}
]
}
}
CareTeam
Example
Query
query CareTeam($id: ID!) {
CareTeam(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
category {
...CodeableConceptFragment
}
name
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
period {
...PeriodFragment
}
participant {
...CareTeamParticipantFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
managingOrganization {
...ReferenceFragment
}
telecom {
...ContactPointFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"CareTeam": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "proposed",
"category": [CodeableConcept],
"name": "xyz789",
"subject": Reference,
"encounter": Reference,
"period": Period,
"participant": [CareTeamParticipant],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"managingOrganization": [Reference],
"telecom": [ContactPoint],
"note": [Annotation]
}
}
}
CareTeamConnection
Response
Returns a CareTeamConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - CareTeamFilterParams!
|
Default = {} |
sort - CareTeamSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query CareTeamConnection(
$upid: ID!,
$filter: CareTeamFilterParams!,
$sort: CareTeamSortParams!,
$first: Int!,
$after: String!
) {
CareTeamConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CareTeamEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"CareTeamConnection": {
"pageInfo": PageInfo,
"edges": [CareTeamEdge]
}
}
}
CareTeamHistory
Response
Returns [CareTeam!]
Example
Query
query CareTeamHistory(
$id: ID!,
$count: Int!
) {
CareTeamHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
category {
...CodeableConceptFragment
}
name
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
period {
...PeriodFragment
}
participant {
...CareTeamParticipantFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
managingOrganization {
...ReferenceFragment
}
telecom {
...ContactPointFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"CareTeamHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "proposed",
"category": [CodeableConcept],
"name": "abc123",
"subject": Reference,
"encounter": Reference,
"period": Period,
"participant": [CareTeamParticipant],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"managingOrganization": [Reference],
"telecom": [ContactPoint],
"note": [Annotation]
}
]
}
}
CareTeamList
Response
Returns [CareTeam!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - CareTeamFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query CareTeamList(
$upid: ID!,
$filter: CareTeamFilterParams!,
$_count: Int!
) {
CareTeamList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
category {
...CodeableConceptFragment
}
name
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
period {
...PeriodFragment
}
participant {
...CareTeamParticipantFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
managingOrganization {
...ReferenceFragment
}
telecom {
...ContactPointFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"CareTeamList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "proposed",
"category": [CodeableConcept],
"name": "abc123",
"subject": Reference,
"encounter": Reference,
"period": Period,
"participant": [CareTeamParticipant],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"managingOrganization": [Reference],
"telecom": [ContactPoint],
"note": [Annotation]
}
]
}
}
Condition
Example
Query
query Condition($id: ID!) {
Condition(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
clinicalStatus {
...CodeableConceptFragment
}
verificationStatus {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
severity {
...CodeableConceptFragment
}
code {
...CodeableConceptFragment
}
bodySite {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
onsetDateTime
onsetAge {
...AgeFragment
}
onsetPeriod {
...PeriodFragment
}
onsetRange {
...RangeFragment
}
onsetString
abatementDateTime
abatementAge {
...AgeFragment
}
abatementPeriod {
...PeriodFragment
}
abatementRange {
...RangeFragment
}
abatementString
recordedDate
recorder {
...ReferenceFragment
}
asserter {
...ReferenceFragment
}
stage {
...ConditionStageFragment
}
evidence {
...ConditionEvidenceFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"Condition": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"clinicalStatus": CodeableConcept,
"verificationStatus": CodeableConcept,
"category": [CodeableConcept],
"severity": CodeableConcept,
"code": CodeableConcept,
"bodySite": [CodeableConcept],
"subject": Reference,
"encounter": Reference,
"onsetDateTime": "abc123",
"onsetAge": Age,
"onsetPeriod": Period,
"onsetRange": Range,
"onsetString": "xyz789",
"abatementDateTime": "abc123",
"abatementAge": Age,
"abatementPeriod": Period,
"abatementRange": Range,
"abatementString": "xyz789",
"recordedDate": "abc123",
"recorder": Reference,
"asserter": Reference,
"stage": [ConditionStage],
"evidence": [ConditionEvidence],
"note": [Annotation]
}
}
}
ConditionConnection
Response
Returns a ConditionConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - ConditionFilterParams!
|
Default = {} |
sort - ConditionSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query ConditionConnection(
$upid: ID!,
$filter: ConditionFilterParams!,
$sort: ConditionSortParams!,
$first: Int!,
$after: String!
) {
ConditionConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ConditionEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"ConditionConnection": {
"pageInfo": PageInfo,
"edges": [ConditionEdge]
}
}
}
ConditionHistory
Response
Returns [Condition!]
Example
Query
query ConditionHistory(
$id: ID!,
$count: Int!
) {
ConditionHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
clinicalStatus {
...CodeableConceptFragment
}
verificationStatus {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
severity {
...CodeableConceptFragment
}
code {
...CodeableConceptFragment
}
bodySite {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
onsetDateTime
onsetAge {
...AgeFragment
}
onsetPeriod {
...PeriodFragment
}
onsetRange {
...RangeFragment
}
onsetString
abatementDateTime
abatementAge {
...AgeFragment
}
abatementPeriod {
...PeriodFragment
}
abatementRange {
...RangeFragment
}
abatementString
recordedDate
recorder {
...ReferenceFragment
}
asserter {
...ReferenceFragment
}
stage {
...ConditionStageFragment
}
evidence {
...ConditionEvidenceFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"ConditionHistory": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"clinicalStatus": CodeableConcept,
"verificationStatus": CodeableConcept,
"category": [CodeableConcept],
"severity": CodeableConcept,
"code": CodeableConcept,
"bodySite": [CodeableConcept],
"subject": Reference,
"encounter": Reference,
"onsetDateTime": "abc123",
"onsetAge": Age,
"onsetPeriod": Period,
"onsetRange": Range,
"onsetString": "abc123",
"abatementDateTime": "abc123",
"abatementAge": Age,
"abatementPeriod": Period,
"abatementRange": Range,
"abatementString": "abc123",
"recordedDate": "xyz789",
"recorder": Reference,
"asserter": Reference,
"stage": [ConditionStage],
"evidence": [ConditionEvidence],
"note": [Annotation]
}
]
}
}
ConditionList
Response
Returns [Condition!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - ConditionFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query ConditionList(
$upid: ID!,
$filter: ConditionFilterParams!,
$_count: Int!
) {
ConditionList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
clinicalStatus {
...CodeableConceptFragment
}
verificationStatus {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
severity {
...CodeableConceptFragment
}
code {
...CodeableConceptFragment
}
bodySite {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
onsetDateTime
onsetAge {
...AgeFragment
}
onsetPeriod {
...PeriodFragment
}
onsetRange {
...RangeFragment
}
onsetString
abatementDateTime
abatementAge {
...AgeFragment
}
abatementPeriod {
...PeriodFragment
}
abatementRange {
...RangeFragment
}
abatementString
recordedDate
recorder {
...ReferenceFragment
}
asserter {
...ReferenceFragment
}
stage {
...ConditionStageFragment
}
evidence {
...ConditionEvidenceFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"ConditionList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"clinicalStatus": CodeableConcept,
"verificationStatus": CodeableConcept,
"category": [CodeableConcept],
"severity": CodeableConcept,
"code": CodeableConcept,
"bodySite": [CodeableConcept],
"subject": Reference,
"encounter": Reference,
"onsetDateTime": "abc123",
"onsetAge": Age,
"onsetPeriod": Period,
"onsetRange": Range,
"onsetString": "abc123",
"abatementDateTime": "xyz789",
"abatementAge": Age,
"abatementPeriod": Period,
"abatementRange": Range,
"abatementString": "abc123",
"recordedDate": "xyz789",
"recorder": Reference,
"asserter": Reference,
"stage": [ConditionStage],
"evidence": [ConditionEvidence],
"note": [Annotation]
}
]
}
}
Consent
Example
Query
query Consent($id: ID!) {
Consent(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
scope {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
dateTime
performer {
...ReferenceFragment
}
organization {
...ReferenceFragment
}
sourceAttachment {
...AttachmentFragment
}
sourceReference {
...ReferenceFragment
}
policy {
...ConsentPolicyFragment
}
policyRule {
...CodeableConceptFragment
}
verification {
...ConsentVerificationFragment
}
provision {
...ConsentProvisionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"Consent": {
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "draft",
"scope": CodeableConcept,
"category": [CodeableConcept],
"patient": Reference,
"dateTime": "abc123",
"performer": [Reference],
"organization": [Reference],
"sourceAttachment": Attachment,
"sourceReference": Reference,
"policy": [ConsentPolicy],
"policyRule": CodeableConcept,
"verification": [ConsentVerification],
"provision": ConsentProvision
}
}
}
ConsentConnection
Response
Returns a ConsentConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - ConsentFilterParams!
|
Default = {} |
sort - ConsentSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query ConsentConnection(
$upid: ID!,
$filter: ConsentFilterParams!,
$sort: ConsentSortParams!,
$first: Int!,
$after: String!
) {
ConsentConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ConsentEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"ConsentConnection": {
"pageInfo": PageInfo,
"edges": [ConsentEdge]
}
}
}
ConsentHistory
Response
Returns [Consent!]
Example
Query
query ConsentHistory(
$id: ID!,
$count: Int!
) {
ConsentHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
scope {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
dateTime
performer {
...ReferenceFragment
}
organization {
...ReferenceFragment
}
sourceAttachment {
...AttachmentFragment
}
sourceReference {
...ReferenceFragment
}
policy {
...ConsentPolicyFragment
}
policyRule {
...CodeableConceptFragment
}
verification {
...ConsentVerificationFragment
}
provision {
...ConsentProvisionFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"ConsentHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "draft",
"scope": CodeableConcept,
"category": [CodeableConcept],
"patient": Reference,
"dateTime": "abc123",
"performer": [Reference],
"organization": [Reference],
"sourceAttachment": Attachment,
"sourceReference": Reference,
"policy": [ConsentPolicy],
"policyRule": CodeableConcept,
"verification": [ConsentVerification],
"provision": ConsentProvision
}
]
}
}
ConsentList
Response
Returns [Consent!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - ConsentFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query ConsentList(
$upid: ID!,
$filter: ConsentFilterParams!,
$_count: Int!
) {
ConsentList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
scope {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
dateTime
performer {
...ReferenceFragment
}
organization {
...ReferenceFragment
}
sourceAttachment {
...AttachmentFragment
}
sourceReference {
...ReferenceFragment
}
policy {
...ConsentPolicyFragment
}
policyRule {
...CodeableConceptFragment
}
verification {
...ConsentVerificationFragment
}
provision {
...ConsentProvisionFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"ConsentList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "draft",
"scope": CodeableConcept,
"category": [CodeableConcept],
"patient": Reference,
"dateTime": "abc123",
"performer": [Reference],
"organization": [Reference],
"sourceAttachment": Attachment,
"sourceReference": Reference,
"policy": [ConsentPolicy],
"policyRule": CodeableConcept,
"verification": [ConsentVerification],
"provision": ConsentProvision
}
]
}
}
Coverage
Example
Query
query Coverage($id: ID!) {
Coverage(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
type {
...CodeableConceptFragment
}
policyHolder {
...ReferenceFragment
}
subscriber {
...ReferenceFragment
}
subscriberId
beneficiary {
...ReferenceFragment
}
dependent
relationship {
...CodeableConceptFragment
}
period {
...PeriodFragment
}
payor {
...ReferenceFragment
}
class {
...CoverageClassFragment
}
order
network
costToBeneficiary {
...CoverageCostToBeneficiaryFragment
}
subrogation
contract {
...ReferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"Coverage": {
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "active",
"type": CodeableConcept,
"policyHolder": Reference,
"subscriber": Reference,
"subscriberId": "abc123",
"beneficiary": Reference,
"dependent": "xyz789",
"relationship": CodeableConcept,
"period": Period,
"payor": [Reference],
"class": [CoverageClass],
"order": 987,
"network": "xyz789",
"costToBeneficiary": [CoverageCostToBeneficiary],
"subrogation": false,
"contract": [Reference]
}
}
}
CoverageConnection
Response
Returns a CoverageConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - CoverageFilterParams!
|
Default = {} |
sort - CoverageSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query CoverageConnection(
$upid: ID!,
$filter: CoverageFilterParams!,
$sort: CoverageSortParams!,
$first: Int!,
$after: String!
) {
CoverageConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CoverageEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"CoverageConnection": {
"pageInfo": PageInfo,
"edges": [CoverageEdge]
}
}
}
CoverageHistory
Response
Returns [Coverage!]
Example
Query
query CoverageHistory(
$id: ID!,
$count: Int!
) {
CoverageHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
type {
...CodeableConceptFragment
}
policyHolder {
...ReferenceFragment
}
subscriber {
...ReferenceFragment
}
subscriberId
beneficiary {
...ReferenceFragment
}
dependent
relationship {
...CodeableConceptFragment
}
period {
...PeriodFragment
}
payor {
...ReferenceFragment
}
class {
...CoverageClassFragment
}
order
network
costToBeneficiary {
...CoverageCostToBeneficiaryFragment
}
subrogation
contract {
...ReferenceFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"CoverageHistory": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "active",
"type": CodeableConcept,
"policyHolder": Reference,
"subscriber": Reference,
"subscriberId": "xyz789",
"beneficiary": Reference,
"dependent": "xyz789",
"relationship": CodeableConcept,
"period": Period,
"payor": [Reference],
"class": [CoverageClass],
"order": 987,
"network": "abc123",
"costToBeneficiary": [CoverageCostToBeneficiary],
"subrogation": false,
"contract": [Reference]
}
]
}
}
CoverageList
Response
Returns [Coverage!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - CoverageFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query CoverageList(
$upid: ID!,
$filter: CoverageFilterParams!,
$_count: Int!
) {
CoverageList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
type {
...CodeableConceptFragment
}
policyHolder {
...ReferenceFragment
}
subscriber {
...ReferenceFragment
}
subscriberId
beneficiary {
...ReferenceFragment
}
dependent
relationship {
...CodeableConceptFragment
}
period {
...PeriodFragment
}
payor {
...ReferenceFragment
}
class {
...CoverageClassFragment
}
order
network
costToBeneficiary {
...CoverageCostToBeneficiaryFragment
}
subrogation
contract {
...ReferenceFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"CoverageList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "active",
"type": CodeableConcept,
"policyHolder": Reference,
"subscriber": Reference,
"subscriberId": "abc123",
"beneficiary": Reference,
"dependent": "xyz789",
"relationship": CodeableConcept,
"period": Period,
"payor": [Reference],
"class": [CoverageClass],
"order": 123,
"network": "abc123",
"costToBeneficiary": [CoverageCostToBeneficiary],
"subrogation": false,
"contract": [Reference]
}
]
}
}
Device
Example
Query
query Device($id: ID!) {
Device(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
definition {
...ReferenceFragment
}
udiCarrier {
...DeviceUdiCarrierFragment
}
status
statusReason {
...CodeableConceptFragment
}
distinctIdentifier
manufacturer
manufactureDate
expirationDate
lotNumber
serialNumber
deviceName {
...DeviceDeviceNameFragment
}
modelNumber
partNumber
type {
...CodeableConceptFragment
}
specialization {
...DeviceSpecializationFragment
}
property {
...DevicePropertyFragment
}
patient {
...ReferenceFragment
}
owner {
...ReferenceFragment
}
contact {
...ContactPointFragment
}
location {
...ReferenceFragment
}
url
note {
...AnnotationFragment
}
safety {
...CodeableConceptFragment
}
parent {
...ReferenceFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"Device": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"definition": Reference,
"udiCarrier": [DeviceUdiCarrier],
"status": "active",
"statusReason": [CodeableConcept],
"distinctIdentifier": "abc123",
"manufacturer": "xyz789",
"manufactureDate": "abc123",
"expirationDate": "abc123",
"lotNumber": "xyz789",
"serialNumber": "xyz789",
"deviceName": [DeviceDeviceName],
"modelNumber": "xyz789",
"partNumber": "xyz789",
"type": CodeableConcept,
"specialization": [DeviceSpecialization],
"property": [DeviceProperty],
"patient": Reference,
"owner": Reference,
"contact": [ContactPoint],
"location": Reference,
"url": "abc123",
"note": [Annotation],
"safety": [CodeableConcept],
"parent": Reference
}
}
}
DeviceConnection
Response
Returns a DeviceConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DeviceFilterParams!
|
Default = {} |
sort - DeviceSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query DeviceConnection(
$upid: ID!,
$filter: DeviceFilterParams!,
$sort: DeviceSortParams!,
$first: Int!,
$after: String!
) {
DeviceConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...DeviceEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"DeviceConnection": {
"pageInfo": PageInfo,
"edges": [DeviceEdge]
}
}
}
DeviceHistory
Example
Query
query DeviceHistory(
$id: ID!,
$count: Int!
) {
DeviceHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
definition {
...ReferenceFragment
}
udiCarrier {
...DeviceUdiCarrierFragment
}
status
statusReason {
...CodeableConceptFragment
}
distinctIdentifier
manufacturer
manufactureDate
expirationDate
lotNumber
serialNumber
deviceName {
...DeviceDeviceNameFragment
}
modelNumber
partNumber
type {
...CodeableConceptFragment
}
specialization {
...DeviceSpecializationFragment
}
property {
...DevicePropertyFragment
}
patient {
...ReferenceFragment
}
owner {
...ReferenceFragment
}
contact {
...ContactPointFragment
}
location {
...ReferenceFragment
}
url
note {
...AnnotationFragment
}
safety {
...CodeableConceptFragment
}
parent {
...ReferenceFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"DeviceHistory": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"definition": Reference,
"udiCarrier": [DeviceUdiCarrier],
"status": "active",
"statusReason": [CodeableConcept],
"distinctIdentifier": "abc123",
"manufacturer": "abc123",
"manufactureDate": "xyz789",
"expirationDate": "abc123",
"lotNumber": "xyz789",
"serialNumber": "xyz789",
"deviceName": [DeviceDeviceName],
"modelNumber": "abc123",
"partNumber": "xyz789",
"type": CodeableConcept,
"specialization": [DeviceSpecialization],
"property": [DeviceProperty],
"patient": Reference,
"owner": Reference,
"contact": [ContactPoint],
"location": Reference,
"url": "abc123",
"note": [Annotation],
"safety": [CodeableConcept],
"parent": Reference
}
]
}
}
DeviceList
Response
Returns [Device!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DeviceFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query DeviceList(
$upid: ID!,
$filter: DeviceFilterParams!,
$_count: Int!
) {
DeviceList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
definition {
...ReferenceFragment
}
udiCarrier {
...DeviceUdiCarrierFragment
}
status
statusReason {
...CodeableConceptFragment
}
distinctIdentifier
manufacturer
manufactureDate
expirationDate
lotNumber
serialNumber
deviceName {
...DeviceDeviceNameFragment
}
modelNumber
partNumber
type {
...CodeableConceptFragment
}
specialization {
...DeviceSpecializationFragment
}
property {
...DevicePropertyFragment
}
patient {
...ReferenceFragment
}
owner {
...ReferenceFragment
}
contact {
...ContactPointFragment
}
location {
...ReferenceFragment
}
url
note {
...AnnotationFragment
}
safety {
...CodeableConceptFragment
}
parent {
...ReferenceFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"DeviceList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"definition": Reference,
"udiCarrier": [DeviceUdiCarrier],
"status": "active",
"statusReason": [CodeableConcept],
"distinctIdentifier": "abc123",
"manufacturer": "xyz789",
"manufactureDate": "abc123",
"expirationDate": "abc123",
"lotNumber": "xyz789",
"serialNumber": "abc123",
"deviceName": [DeviceDeviceName],
"modelNumber": "abc123",
"partNumber": "xyz789",
"type": CodeableConcept,
"specialization": [DeviceSpecialization],
"property": [DeviceProperty],
"patient": Reference,
"owner": Reference,
"contact": [ContactPoint],
"location": Reference,
"url": "abc123",
"note": [Annotation],
"safety": [CodeableConcept],
"parent": Reference
}
]
}
}
DeviceUseStatement
Response
Returns a DeviceUseStatement
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query DeviceUseStatement($id: ID!) {
DeviceUseStatement(id: $id) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
basedOn {
...ReferenceFragment
}
status
subject {
...ReferenceFragment
}
derivedFrom {
...ReferenceFragment
}
timingTiming {
...TimingFragment
}
timingPeriod {
...PeriodFragment
}
timingDateTime
recordedOn
source {
...ReferenceFragment
}
device {
...ReferenceFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
bodySite {
...CodeableConceptFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"DeviceUseStatement": {
"resourceType": "xyz789",
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"basedOn": [Reference],
"status": "active",
"subject": Reference,
"derivedFrom": [Reference],
"timingTiming": Timing,
"timingPeriod": Period,
"timingDateTime": "xyz789",
"recordedOn": "xyz789",
"source": Reference,
"device": Reference,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"bodySite": CodeableConcept,
"note": [Annotation]
}
}
}
DeviceUseStatementConnection
Response
Returns a DeviceUseStatementConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DeviceUseStatementFilterParams!
|
Default = {} |
sort - DeviceUseStatementSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query DeviceUseStatementConnection(
$upid: ID!,
$filter: DeviceUseStatementFilterParams!,
$sort: DeviceUseStatementSortParams!,
$first: Int!,
$after: String!
) {
DeviceUseStatementConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...DeviceUseStatementEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"DeviceUseStatementConnection": {
"pageInfo": PageInfo,
"edges": [DeviceUseStatementEdge]
}
}
}
DeviceUseStatementHistory
Response
Returns [DeviceUseStatement!]
Example
Query
query DeviceUseStatementHistory(
$id: ID!,
$count: Int!
) {
DeviceUseStatementHistory(
id: $id,
count: $count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
basedOn {
...ReferenceFragment
}
status
subject {
...ReferenceFragment
}
derivedFrom {
...ReferenceFragment
}
timingTiming {
...TimingFragment
}
timingPeriod {
...PeriodFragment
}
timingDateTime
recordedOn
source {
...ReferenceFragment
}
device {
...ReferenceFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
bodySite {
...CodeableConceptFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"DeviceUseStatementHistory": [
{
"resourceType": "abc123",
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"basedOn": [Reference],
"status": "active",
"subject": Reference,
"derivedFrom": [Reference],
"timingTiming": Timing,
"timingPeriod": Period,
"timingDateTime": "xyz789",
"recordedOn": "abc123",
"source": Reference,
"device": Reference,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"bodySite": CodeableConcept,
"note": [Annotation]
}
]
}
}
DeviceUseStatementList
Response
Returns [DeviceUseStatement!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DeviceUseStatementFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query DeviceUseStatementList(
$upid: ID!,
$filter: DeviceUseStatementFilterParams!,
$_count: Int!
) {
DeviceUseStatementList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
basedOn {
...ReferenceFragment
}
status
subject {
...ReferenceFragment
}
derivedFrom {
...ReferenceFragment
}
timingTiming {
...TimingFragment
}
timingPeriod {
...PeriodFragment
}
timingDateTime
recordedOn
source {
...ReferenceFragment
}
device {
...ReferenceFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
bodySite {
...CodeableConceptFragment
}
note {
...AnnotationFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"DeviceUseStatementList": [
{
"resourceType": "abc123",
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"basedOn": [Reference],
"status": "active",
"subject": Reference,
"derivedFrom": [Reference],
"timingTiming": Timing,
"timingPeriod": Period,
"timingDateTime": "abc123",
"recordedOn": "abc123",
"source": Reference,
"device": Reference,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"bodySite": CodeableConcept,
"note": [Annotation]
}
]
}
}
DiagnosticReport
Response
Returns a DiagnosticReport
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query DiagnosticReport($id: ID!) {
DiagnosticReport(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
basedOn {
...ReferenceFragment
}
status
category {
...CodeableConceptFragment
}
code {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
effectiveDateTime
effectivePeriod {
...PeriodFragment
}
issued
performer {
...ReferenceFragment
}
resultsInterpreter {
...ReferenceFragment
}
specimen {
...ReferenceFragment
}
result {
...ReferenceFragment
}
imagingStudy {
...ReferenceFragment
}
media {
...DiagnosticReportMediaFragment
}
conclusion
conclusionCode {
...CodeableConceptFragment
}
presentedForm {
...AttachmentFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"DiagnosticReport": {
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"basedOn": [Reference],
"status": "registered",
"category": [CodeableConcept],
"code": CodeableConcept,
"subject": Reference,
"encounter": Reference,
"effectiveDateTime": "abc123",
"effectivePeriod": Period,
"issued": "abc123",
"performer": [Reference],
"resultsInterpreter": [Reference],
"specimen": [Reference],
"result": [Reference],
"imagingStudy": [Reference],
"media": [DiagnosticReportMedia],
"conclusion": "abc123",
"conclusionCode": [CodeableConcept],
"presentedForm": [Attachment]
}
}
}
DiagnosticReportConnection
Response
Returns a DiagnosticReportConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DiagnosticReportFilterParams!
|
Default = {} |
sort - DiagnosticReportSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query DiagnosticReportConnection(
$upid: ID!,
$filter: DiagnosticReportFilterParams!,
$sort: DiagnosticReportSortParams!,
$first: Int!,
$after: String!
) {
DiagnosticReportConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...DiagnosticReportEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"DiagnosticReportConnection": {
"pageInfo": PageInfo,
"edges": [DiagnosticReportEdge]
}
}
}
DiagnosticReportHistory
Response
Returns [DiagnosticReport!]
Example
Query
query DiagnosticReportHistory(
$id: ID!,
$count: Int!
) {
DiagnosticReportHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
basedOn {
...ReferenceFragment
}
status
category {
...CodeableConceptFragment
}
code {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
effectiveDateTime
effectivePeriod {
...PeriodFragment
}
issued
performer {
...ReferenceFragment
}
resultsInterpreter {
...ReferenceFragment
}
specimen {
...ReferenceFragment
}
result {
...ReferenceFragment
}
imagingStudy {
...ReferenceFragment
}
media {
...DiagnosticReportMediaFragment
}
conclusion
conclusionCode {
...CodeableConceptFragment
}
presentedForm {
...AttachmentFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"DiagnosticReportHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"basedOn": [Reference],
"status": "registered",
"category": [CodeableConcept],
"code": CodeableConcept,
"subject": Reference,
"encounter": Reference,
"effectiveDateTime": "abc123",
"effectivePeriod": Period,
"issued": "xyz789",
"performer": [Reference],
"resultsInterpreter": [Reference],
"specimen": [Reference],
"result": [Reference],
"imagingStudy": [Reference],
"media": [DiagnosticReportMedia],
"conclusion": "xyz789",
"conclusionCode": [CodeableConcept],
"presentedForm": [Attachment]
}
]
}
}
DiagnosticReportList
Response
Returns [DiagnosticReport!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DiagnosticReportFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query DiagnosticReportList(
$upid: ID!,
$filter: DiagnosticReportFilterParams!,
$_count: Int!
) {
DiagnosticReportList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
basedOn {
...ReferenceFragment
}
status
category {
...CodeableConceptFragment
}
code {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
effectiveDateTime
effectivePeriod {
...PeriodFragment
}
issued
performer {
...ReferenceFragment
}
resultsInterpreter {
...ReferenceFragment
}
specimen {
...ReferenceFragment
}
result {
...ReferenceFragment
}
imagingStudy {
...ReferenceFragment
}
media {
...DiagnosticReportMediaFragment
}
conclusion
conclusionCode {
...CodeableConceptFragment
}
presentedForm {
...AttachmentFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"DiagnosticReportList": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"basedOn": [Reference],
"status": "registered",
"category": [CodeableConcept],
"code": CodeableConcept,
"subject": Reference,
"encounter": Reference,
"effectiveDateTime": "xyz789",
"effectivePeriod": Period,
"issued": "abc123",
"performer": [Reference],
"resultsInterpreter": [Reference],
"specimen": [Reference],
"result": [Reference],
"imagingStudy": [Reference],
"media": [DiagnosticReportMedia],
"conclusion": "xyz789",
"conclusionCode": [CodeableConcept],
"presentedForm": [Attachment]
}
]
}
}
DocumentReference
Response
Returns a DocumentReference
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query DocumentReference($id: ID!) {
DocumentReference(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
masterIdentifier {
...IdentifierFragment
}
identifier {
...IdentifierFragment
}
status
docStatus
type {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
date
author {
...ReferenceFragment
}
authenticator {
...ReferenceFragment
}
custodian {
...ReferenceFragment
}
relatesTo {
...DocumentReferenceRelatesToFragment
}
description
securityLabel {
...CodeableConceptFragment
}
content {
...DocumentReferenceContentFragment
}
context {
...DocumentReferenceContextFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"DocumentReference": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"masterIdentifier": Identifier,
"identifier": [Identifier],
"status": "current",
"docStatus": "preliminary",
"type": CodeableConcept,
"category": [CodeableConcept],
"subject": Reference,
"date": "xyz789",
"author": [Reference],
"authenticator": Reference,
"custodian": Reference,
"relatesTo": [DocumentReferenceRelatesTo],
"description": "xyz789",
"securityLabel": [CodeableConcept],
"content": [DocumentReferenceContent],
"context": DocumentReferenceContext
}
}
}
DocumentReferenceConnection
Response
Returns a DocumentReferenceConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DocumentReferenceFilterParams!
|
Default = {} |
sort - DocumentReferenceSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query DocumentReferenceConnection(
$upid: ID!,
$filter: DocumentReferenceFilterParams!,
$sort: DocumentReferenceSortParams!,
$first: Int!,
$after: String!
) {
DocumentReferenceConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...DocumentReferenceEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"DocumentReferenceConnection": {
"pageInfo": PageInfo,
"edges": [DocumentReferenceEdge]
}
}
}
DocumentReferenceHistory
Response
Returns [DocumentReference!]
Example
Query
query DocumentReferenceHistory(
$id: ID!,
$count: Int!
) {
DocumentReferenceHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
masterIdentifier {
...IdentifierFragment
}
identifier {
...IdentifierFragment
}
status
docStatus
type {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
date
author {
...ReferenceFragment
}
authenticator {
...ReferenceFragment
}
custodian {
...ReferenceFragment
}
relatesTo {
...DocumentReferenceRelatesToFragment
}
description
securityLabel {
...CodeableConceptFragment
}
content {
...DocumentReferenceContentFragment
}
context {
...DocumentReferenceContextFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"DocumentReferenceHistory": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"masterIdentifier": Identifier,
"identifier": [Identifier],
"status": "current",
"docStatus": "preliminary",
"type": CodeableConcept,
"category": [CodeableConcept],
"subject": Reference,
"date": "xyz789",
"author": [Reference],
"authenticator": Reference,
"custodian": Reference,
"relatesTo": [DocumentReferenceRelatesTo],
"description": "xyz789",
"securityLabel": [CodeableConcept],
"content": [DocumentReferenceContent],
"context": DocumentReferenceContext
}
]
}
}
DocumentReferenceList
Response
Returns [DocumentReference!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - DocumentReferenceFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query DocumentReferenceList(
$upid: ID!,
$filter: DocumentReferenceFilterParams!,
$_count: Int!
) {
DocumentReferenceList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
masterIdentifier {
...IdentifierFragment
}
identifier {
...IdentifierFragment
}
status
docStatus
type {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
date
author {
...ReferenceFragment
}
authenticator {
...ReferenceFragment
}
custodian {
...ReferenceFragment
}
relatesTo {
...DocumentReferenceRelatesToFragment
}
description
securityLabel {
...CodeableConceptFragment
}
content {
...DocumentReferenceContentFragment
}
context {
...DocumentReferenceContextFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"DocumentReferenceList": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"masterIdentifier": Identifier,
"identifier": [Identifier],
"status": "current",
"docStatus": "preliminary",
"type": CodeableConcept,
"category": [CodeableConcept],
"subject": Reference,
"date": "abc123",
"author": [Reference],
"authenticator": Reference,
"custodian": Reference,
"relatesTo": [DocumentReferenceRelatesTo],
"description": "abc123",
"securityLabel": [CodeableConcept],
"content": [DocumentReferenceContent],
"context": DocumentReferenceContext
}
]
}
}
Encounter
Example
Query
query Encounter($id: ID!) {
Encounter(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusHistory {
...EncounterStatusHistoryFragment
}
class {
...CodingFragment
}
classHistory {
...EncounterClassHistoryFragment
}
type {
...CodeableConceptFragment
}
serviceType {
...CodeableConceptFragment
}
priority {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
episodeOfCare {
...ReferenceFragment
}
basedOn {
...ReferenceFragment
}
participant {
...EncounterParticipantFragment
}
appointment {
...ReferenceFragment
}
period {
...PeriodFragment
}
length {
...DurationFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
diagnosis {
...EncounterDiagnosisFragment
}
account {
...ReferenceFragment
}
hospitalization {
...EncounterHospitalizationFragment
}
location {
...EncounterLocationFragment
}
serviceProvider {
...ReferenceFragment
}
partOf {
...ReferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"Encounter": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "planned",
"statusHistory": [EncounterStatusHistory],
"class": Coding,
"classHistory": [EncounterClassHistory],
"type": [CodeableConcept],
"serviceType": CodeableConcept,
"priority": CodeableConcept,
"subject": Reference,
"episodeOfCare": [Reference],
"basedOn": [Reference],
"participant": [EncounterParticipant],
"appointment": [Reference],
"period": Period,
"length": Duration,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"diagnosis": [EncounterDiagnosis],
"account": [Reference],
"hospitalization": EncounterHospitalization,
"location": [EncounterLocation],
"serviceProvider": Reference,
"partOf": Reference
}
}
}
EncounterConnection
Response
Returns an EncounterConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - EncounterFilterParams!
|
Default = {} |
sort - EncounterSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query EncounterConnection(
$upid: ID!,
$filter: EncounterFilterParams!,
$sort: EncounterSortParams!,
$first: Int!,
$after: String!
) {
EncounterConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...EncounterEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"EncounterConnection": {
"pageInfo": PageInfo,
"edges": [EncounterEdge]
}
}
}
EncounterHistory
Response
Returns [Encounter!]
Example
Query
query EncounterHistory(
$id: ID!,
$count: Int!
) {
EncounterHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusHistory {
...EncounterStatusHistoryFragment
}
class {
...CodingFragment
}
classHistory {
...EncounterClassHistoryFragment
}
type {
...CodeableConceptFragment
}
serviceType {
...CodeableConceptFragment
}
priority {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
episodeOfCare {
...ReferenceFragment
}
basedOn {
...ReferenceFragment
}
participant {
...EncounterParticipantFragment
}
appointment {
...ReferenceFragment
}
period {
...PeriodFragment
}
length {
...DurationFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
diagnosis {
...EncounterDiagnosisFragment
}
account {
...ReferenceFragment
}
hospitalization {
...EncounterHospitalizationFragment
}
location {
...EncounterLocationFragment
}
serviceProvider {
...ReferenceFragment
}
partOf {
...ReferenceFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"EncounterHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "planned",
"statusHistory": [EncounterStatusHistory],
"class": Coding,
"classHistory": [EncounterClassHistory],
"type": [CodeableConcept],
"serviceType": CodeableConcept,
"priority": CodeableConcept,
"subject": Reference,
"episodeOfCare": [Reference],
"basedOn": [Reference],
"participant": [EncounterParticipant],
"appointment": [Reference],
"period": Period,
"length": Duration,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"diagnosis": [EncounterDiagnosis],
"account": [Reference],
"hospitalization": EncounterHospitalization,
"location": [EncounterLocation],
"serviceProvider": Reference,
"partOf": Reference
}
]
}
}
EncounterList
Response
Returns [Encounter!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - EncounterFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query EncounterList(
$upid: ID!,
$filter: EncounterFilterParams!,
$_count: Int!
) {
EncounterList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusHistory {
...EncounterStatusHistoryFragment
}
class {
...CodingFragment
}
classHistory {
...EncounterClassHistoryFragment
}
type {
...CodeableConceptFragment
}
serviceType {
...CodeableConceptFragment
}
priority {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
episodeOfCare {
...ReferenceFragment
}
basedOn {
...ReferenceFragment
}
participant {
...EncounterParticipantFragment
}
appointment {
...ReferenceFragment
}
period {
...PeriodFragment
}
length {
...DurationFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
diagnosis {
...EncounterDiagnosisFragment
}
account {
...ReferenceFragment
}
hospitalization {
...EncounterHospitalizationFragment
}
location {
...EncounterLocationFragment
}
serviceProvider {
...ReferenceFragment
}
partOf {
...ReferenceFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"EncounterList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "planned",
"statusHistory": [EncounterStatusHistory],
"class": Coding,
"classHistory": [EncounterClassHistory],
"type": [CodeableConcept],
"serviceType": CodeableConcept,
"priority": CodeableConcept,
"subject": Reference,
"episodeOfCare": [Reference],
"basedOn": [Reference],
"participant": [EncounterParticipant],
"appointment": [Reference],
"period": Period,
"length": Duration,
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"diagnosis": [EncounterDiagnosis],
"account": [Reference],
"hospitalization": EncounterHospitalization,
"location": [EncounterLocation],
"serviceProvider": Reference,
"partOf": Reference
}
]
}
}
EpisodeOfCare
Response
Returns an EpisodeOfCare
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query EpisodeOfCare($id: ID!) {
EpisodeOfCare(id: $id) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusHistory {
...EpisodeOfCareStatusHistoryFragment
}
type {
...CodeableConceptFragment
}
diagnosis {
...EpisodeOfCareDiagnosisFragment
}
patient {
...ReferenceFragment
}
managingOrganization {
...ReferenceFragment
}
period {
...PeriodFragment
}
referralRequest {
...ReferenceFragment
}
careManager {
...ReferenceFragment
}
team {
...ReferenceFragment
}
account {
...ReferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"EpisodeOfCare": {
"resourceType": "abc123",
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "planned",
"statusHistory": [EpisodeOfCareStatusHistory],
"type": [CodeableConcept],
"diagnosis": [EpisodeOfCareDiagnosis],
"patient": Reference,
"managingOrganization": Reference,
"period": Period,
"referralRequest": [Reference],
"careManager": Reference,
"team": [Reference],
"account": [Reference]
}
}
}
EpisodeOfCareConnection
Response
Returns an EpisodeOfCareConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - EpisodeOfCareFilterParams!
|
Default = {} |
sort - EpisodeOfCareSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query EpisodeOfCareConnection(
$upid: ID!,
$filter: EpisodeOfCareFilterParams!,
$sort: EpisodeOfCareSortParams!,
$first: Int!,
$after: String!
) {
EpisodeOfCareConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...EpisodeOfCareEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"EpisodeOfCareConnection": {
"pageInfo": PageInfo,
"edges": [EpisodeOfCareEdge]
}
}
}
EpisodeOfCareHistory
Response
Returns [EpisodeOfCare!]
Example
Query
query EpisodeOfCareHistory(
$id: ID!,
$count: Int!
) {
EpisodeOfCareHistory(
id: $id,
count: $count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusHistory {
...EpisodeOfCareStatusHistoryFragment
}
type {
...CodeableConceptFragment
}
diagnosis {
...EpisodeOfCareDiagnosisFragment
}
patient {
...ReferenceFragment
}
managingOrganization {
...ReferenceFragment
}
period {
...PeriodFragment
}
referralRequest {
...ReferenceFragment
}
careManager {
...ReferenceFragment
}
team {
...ReferenceFragment
}
account {
...ReferenceFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"EpisodeOfCareHistory": [
{
"resourceType": "abc123",
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "planned",
"statusHistory": [EpisodeOfCareStatusHistory],
"type": [CodeableConcept],
"diagnosis": [EpisodeOfCareDiagnosis],
"patient": Reference,
"managingOrganization": Reference,
"period": Period,
"referralRequest": [Reference],
"careManager": Reference,
"team": [Reference],
"account": [Reference]
}
]
}
}
EpisodeOfCareList
Response
Returns [EpisodeOfCare!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - EpisodeOfCareFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query EpisodeOfCareList(
$upid: ID!,
$filter: EpisodeOfCareFilterParams!,
$_count: Int!
) {
EpisodeOfCareList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusHistory {
...EpisodeOfCareStatusHistoryFragment
}
type {
...CodeableConceptFragment
}
diagnosis {
...EpisodeOfCareDiagnosisFragment
}
patient {
...ReferenceFragment
}
managingOrganization {
...ReferenceFragment
}
period {
...PeriodFragment
}
referralRequest {
...ReferenceFragment
}
careManager {
...ReferenceFragment
}
team {
...ReferenceFragment
}
account {
...ReferenceFragment
}
}
}
Variables
{"upid": "4", "filter": {}, "_count": 10}
Response
{
"data": {
"EpisodeOfCareList": [
{
"resourceType": "abc123",
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "planned",
"statusHistory": [EpisodeOfCareStatusHistory],
"type": [CodeableConcept],
"diagnosis": [EpisodeOfCareDiagnosis],
"patient": Reference,
"managingOrganization": Reference,
"period": Period,
"referralRequest": [Reference],
"careManager": Reference,
"team": [Reference],
"account": [Reference]
}
]
}
}
FamilyMemberHistory
Response
Returns a FamilyMemberHistory
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query FamilyMemberHistory($id: ID!) {
FamilyMemberHistory(id: $id) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiatesCanonical
instantiatesUri
status
dataAbsentReason {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
date
name
relationship {
...CodeableConceptFragment
}
sex {
...CodeableConceptFragment
}
bornPeriod {
...PeriodFragment
}
bornDate
bornString
ageAge {
...AgeFragment
}
ageRange {
...RangeFragment
}
ageString
estimatedAge
deceasedBoolean
deceasedAge {
...AgeFragment
}
deceasedRange {
...RangeFragment
}
deceasedDate
deceasedString
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
note {
...AnnotationFragment
}
condition {
...FamilyMemberHistoryConditionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"FamilyMemberHistory": {
"resourceType": "xyz789",
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiatesCanonical": ["xyz789"],
"instantiatesUri": ["xyz789"],
"status": "partial",
"dataAbsentReason": CodeableConcept,
"patient": Reference,
"date": "abc123",
"name": "abc123",
"relationship": CodeableConcept,
"sex": CodeableConcept,
"bornPeriod": Period,
"bornDate": "xyz789",
"bornString": "abc123",
"ageAge": Age,
"ageRange": Range,
"ageString": "abc123",
"estimatedAge": true,
"deceasedBoolean": false,
"deceasedAge": Age,
"deceasedRange": Range,
"deceasedDate": "xyz789",
"deceasedString": "xyz789",
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"note": [Annotation],
"condition": [FamilyMemberHistoryCondition]
}
}
}
FamilyMemberHistoryConnection
Response
Returns a FamilyMemberHistoryConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - FamilyMemberHistoryFilterParams!
|
Default = {} |
sort - FamilyMemberHistorySortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query FamilyMemberHistoryConnection(
$upid: ID!,
$filter: FamilyMemberHistoryFilterParams!,
$sort: FamilyMemberHistorySortParams!,
$first: Int!,
$after: String!
) {
FamilyMemberHistoryConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...FamilyMemberHistoryEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"FamilyMemberHistoryConnection": {
"pageInfo": PageInfo,
"edges": [FamilyMemberHistoryEdge]
}
}
}
FamilyMemberHistoryHistory
Response
Returns [FamilyMemberHistory!]
Example
Query
query FamilyMemberHistoryHistory(
$id: ID!,
$count: Int!
) {
FamilyMemberHistoryHistory(
id: $id,
count: $count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiatesCanonical
instantiatesUri
status
dataAbsentReason {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
date
name
relationship {
...CodeableConceptFragment
}
sex {
...CodeableConceptFragment
}
bornPeriod {
...PeriodFragment
}
bornDate
bornString
ageAge {
...AgeFragment
}
ageRange {
...RangeFragment
}
ageString
estimatedAge
deceasedBoolean
deceasedAge {
...AgeFragment
}
deceasedRange {
...RangeFragment
}
deceasedDate
deceasedString
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
note {
...AnnotationFragment
}
condition {
...FamilyMemberHistoryConditionFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"FamilyMemberHistoryHistory": [
{
"resourceType": "xyz789",
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiatesCanonical": ["xyz789"],
"instantiatesUri": ["abc123"],
"status": "partial",
"dataAbsentReason": CodeableConcept,
"patient": Reference,
"date": "abc123",
"name": "xyz789",
"relationship": CodeableConcept,
"sex": CodeableConcept,
"bornPeriod": Period,
"bornDate": "xyz789",
"bornString": "abc123",
"ageAge": Age,
"ageRange": Range,
"ageString": "xyz789",
"estimatedAge": false,
"deceasedBoolean": true,
"deceasedAge": Age,
"deceasedRange": Range,
"deceasedDate": "abc123",
"deceasedString": "abc123",
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"note": [Annotation],
"condition": [FamilyMemberHistoryCondition]
}
]
}
}
FamilyMemberHistoryList
Response
Returns [FamilyMemberHistory!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - FamilyMemberHistoryFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query FamilyMemberHistoryList(
$upid: ID!,
$filter: FamilyMemberHistoryFilterParams!,
$_count: Int!
) {
FamilyMemberHistoryList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiatesCanonical
instantiatesUri
status
dataAbsentReason {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
date
name
relationship {
...CodeableConceptFragment
}
sex {
...CodeableConceptFragment
}
bornPeriod {
...PeriodFragment
}
bornDate
bornString
ageAge {
...AgeFragment
}
ageRange {
...RangeFragment
}
ageString
estimatedAge
deceasedBoolean
deceasedAge {
...AgeFragment
}
deceasedRange {
...RangeFragment
}
deceasedDate
deceasedString
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
note {
...AnnotationFragment
}
condition {
...FamilyMemberHistoryConditionFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"FamilyMemberHistoryList": [
{
"resourceType": "xyz789",
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiatesCanonical": ["xyz789"],
"instantiatesUri": ["xyz789"],
"status": "partial",
"dataAbsentReason": CodeableConcept,
"patient": Reference,
"date": "abc123",
"name": "xyz789",
"relationship": CodeableConcept,
"sex": CodeableConcept,
"bornPeriod": Period,
"bornDate": "xyz789",
"bornString": "abc123",
"ageAge": Age,
"ageRange": Range,
"ageString": "abc123",
"estimatedAge": false,
"deceasedBoolean": false,
"deceasedAge": Age,
"deceasedRange": Range,
"deceasedDate": "xyz789",
"deceasedString": "abc123",
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"note": [Annotation],
"condition": [FamilyMemberHistoryCondition]
}
]
}
}
Goal
Example
Query
query Goal($id: ID!) {
Goal(id: $id) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
lifecycleStatus
achievementStatus {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
priority {
...CodeableConceptFragment
}
description {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
startDate
startCodeableConcept {
...CodeableConceptFragment
}
target {
...GoalTargetFragment
}
statusDate
statusReason
expressedBy {
...ReferenceFragment
}
addresses {
...ReferenceFragment
}
note {
...AnnotationFragment
}
outcomeCode {
...CodeableConceptFragment
}
outcomeReference {
...ReferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"Goal": {
"resourceType": "abc123",
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"lifecycleStatus": "proposed",
"achievementStatus": CodeableConcept,
"category": [CodeableConcept],
"priority": CodeableConcept,
"description": CodeableConcept,
"subject": Reference,
"startDate": "abc123",
"startCodeableConcept": CodeableConcept,
"target": [GoalTarget],
"statusDate": "xyz789",
"statusReason": "xyz789",
"expressedBy": Reference,
"addresses": [Reference],
"note": [Annotation],
"outcomeCode": [CodeableConcept],
"outcomeReference": [Reference]
}
}
}
GoalConnection
Response
Returns a GoalConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - GoalFilterParams!
|
Default = {} |
sort - GoalSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query GoalConnection(
$upid: ID!,
$filter: GoalFilterParams!,
$sort: GoalSortParams!,
$first: Int!,
$after: String!
) {
GoalConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...GoalEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"GoalConnection": {
"pageInfo": PageInfo,
"edges": [GoalEdge]
}
}
}
GoalHistory
Example
Query
query GoalHistory(
$id: ID!,
$count: Int!
) {
GoalHistory(
id: $id,
count: $count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
lifecycleStatus
achievementStatus {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
priority {
...CodeableConceptFragment
}
description {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
startDate
startCodeableConcept {
...CodeableConceptFragment
}
target {
...GoalTargetFragment
}
statusDate
statusReason
expressedBy {
...ReferenceFragment
}
addresses {
...ReferenceFragment
}
note {
...AnnotationFragment
}
outcomeCode {
...CodeableConceptFragment
}
outcomeReference {
...ReferenceFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"GoalHistory": [
{
"resourceType": "xyz789",
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"lifecycleStatus": "proposed",
"achievementStatus": CodeableConcept,
"category": [CodeableConcept],
"priority": CodeableConcept,
"description": CodeableConcept,
"subject": Reference,
"startDate": "abc123",
"startCodeableConcept": CodeableConcept,
"target": [GoalTarget],
"statusDate": "abc123",
"statusReason": "xyz789",
"expressedBy": Reference,
"addresses": [Reference],
"note": [Annotation],
"outcomeCode": [CodeableConcept],
"outcomeReference": [Reference]
}
]
}
}
GoalList
Response
Returns [Goal!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - GoalFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query GoalList(
$upid: ID!,
$filter: GoalFilterParams!,
$_count: Int!
) {
GoalList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
lifecycleStatus
achievementStatus {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
priority {
...CodeableConceptFragment
}
description {
...CodeableConceptFragment
}
subject {
...ReferenceFragment
}
startDate
startCodeableConcept {
...CodeableConceptFragment
}
target {
...GoalTargetFragment
}
statusDate
statusReason
expressedBy {
...ReferenceFragment
}
addresses {
...ReferenceFragment
}
note {
...AnnotationFragment
}
outcomeCode {
...CodeableConceptFragment
}
outcomeReference {
...ReferenceFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"GoalList": [
{
"resourceType": "xyz789",
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"lifecycleStatus": "proposed",
"achievementStatus": CodeableConcept,
"category": [CodeableConcept],
"priority": CodeableConcept,
"description": CodeableConcept,
"subject": Reference,
"startDate": "xyz789",
"startCodeableConcept": CodeableConcept,
"target": [GoalTarget],
"statusDate": "xyz789",
"statusReason": "abc123",
"expressedBy": Reference,
"addresses": [Reference],
"note": [Annotation],
"outcomeCode": [CodeableConcept],
"outcomeReference": [Reference]
}
]
}
}
Immunization
Response
Returns an Immunization
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query Immunization($id: ID!) {
Immunization(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusReason {
...CodeableConceptFragment
}
vaccineCode {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
occurrenceDateTime
occurrenceString
recorded
primarySource
reportOrigin {
...CodeableConceptFragment
}
location {
...ReferenceFragment
}
manufacturer {
...ReferenceFragment
}
lotNumber
expirationDate
site {
...CodeableConceptFragment
}
route {
...CodeableConceptFragment
}
doseQuantity {
...QuantityFragment
}
performer {
...ImmunizationPerformerFragment
}
note {
...AnnotationFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
isSubpotent
subpotentReason {
...CodeableConceptFragment
}
education {
...ImmunizationEducationFragment
}
programEligibility {
...CodeableConceptFragment
}
fundingSource {
...CodeableConceptFragment
}
reaction {
...ImmunizationReactionFragment
}
protocolApplied {
...ImmunizationProtocolAppliedFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"Immunization": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "completed",
"statusReason": CodeableConcept,
"vaccineCode": CodeableConcept,
"patient": Reference,
"encounter": Reference,
"occurrenceDateTime": "xyz789",
"occurrenceString": "xyz789",
"recorded": "abc123",
"primarySource": true,
"reportOrigin": CodeableConcept,
"location": Reference,
"manufacturer": Reference,
"lotNumber": "xyz789",
"expirationDate": "xyz789",
"site": CodeableConcept,
"route": CodeableConcept,
"doseQuantity": Quantity,
"performer": [ImmunizationPerformer],
"note": [Annotation],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"isSubpotent": false,
"subpotentReason": [CodeableConcept],
"education": [ImmunizationEducation],
"programEligibility": [CodeableConcept],
"fundingSource": CodeableConcept,
"reaction": [ImmunizationReaction],
"protocolApplied": [ImmunizationProtocolApplied]
}
}
}
ImmunizationConnection
Response
Returns an ImmunizationConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - ImmunizationFilterParams!
|
Default = {} |
sort - ImmunizationSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query ImmunizationConnection(
$upid: ID!,
$filter: ImmunizationFilterParams!,
$sort: ImmunizationSortParams!,
$first: Int!,
$after: String!
) {
ImmunizationConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ImmunizationEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"ImmunizationConnection": {
"pageInfo": PageInfo,
"edges": [ImmunizationEdge]
}
}
}
ImmunizationHistory
Response
Returns [Immunization!]
Example
Query
query ImmunizationHistory(
$id: ID!,
$count: Int!
) {
ImmunizationHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusReason {
...CodeableConceptFragment
}
vaccineCode {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
occurrenceDateTime
occurrenceString
recorded
primarySource
reportOrigin {
...CodeableConceptFragment
}
location {
...ReferenceFragment
}
manufacturer {
...ReferenceFragment
}
lotNumber
expirationDate
site {
...CodeableConceptFragment
}
route {
...CodeableConceptFragment
}
doseQuantity {
...QuantityFragment
}
performer {
...ImmunizationPerformerFragment
}
note {
...AnnotationFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
isSubpotent
subpotentReason {
...CodeableConceptFragment
}
education {
...ImmunizationEducationFragment
}
programEligibility {
...CodeableConceptFragment
}
fundingSource {
...CodeableConceptFragment
}
reaction {
...ImmunizationReactionFragment
}
protocolApplied {
...ImmunizationProtocolAppliedFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"ImmunizationHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "completed",
"statusReason": CodeableConcept,
"vaccineCode": CodeableConcept,
"patient": Reference,
"encounter": Reference,
"occurrenceDateTime": "xyz789",
"occurrenceString": "xyz789",
"recorded": "xyz789",
"primarySource": true,
"reportOrigin": CodeableConcept,
"location": Reference,
"manufacturer": Reference,
"lotNumber": "abc123",
"expirationDate": "xyz789",
"site": CodeableConcept,
"route": CodeableConcept,
"doseQuantity": Quantity,
"performer": [ImmunizationPerformer],
"note": [Annotation],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"isSubpotent": true,
"subpotentReason": [CodeableConcept],
"education": [ImmunizationEducation],
"programEligibility": [CodeableConcept],
"fundingSource": CodeableConcept,
"reaction": [ImmunizationReaction],
"protocolApplied": [ImmunizationProtocolApplied]
}
]
}
}
ImmunizationList
Response
Returns [Immunization!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - ImmunizationFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query ImmunizationList(
$upid: ID!,
$filter: ImmunizationFilterParams!,
$_count: Int!
) {
ImmunizationList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
BasicList {
...BasicFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
statusReason {
...CodeableConceptFragment
}
vaccineCode {
...CodeableConceptFragment
}
patient {
...ReferenceFragment
}
encounter {
...ReferenceFragment
}
occurrenceDateTime
occurrenceString
recorded
primarySource
reportOrigin {
...CodeableConceptFragment
}
location {
...ReferenceFragment
}
manufacturer {
...ReferenceFragment
}
lotNumber
expirationDate
site {
...CodeableConceptFragment
}
route {
...CodeableConceptFragment
}
doseQuantity {
...QuantityFragment
}
performer {
...ImmunizationPerformerFragment
}
note {
...AnnotationFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
isSubpotent
subpotentReason {
...CodeableConceptFragment
}
education {
...ImmunizationEducationFragment
}
programEligibility {
...CodeableConceptFragment
}
fundingSource {
...CodeableConceptFragment
}
reaction {
...ImmunizationReactionFragment
}
protocolApplied {
...ImmunizationProtocolAppliedFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"ImmunizationList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"BasicList": [Basic],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "completed",
"statusReason": CodeableConcept,
"vaccineCode": CodeableConcept,
"patient": Reference,
"encounter": Reference,
"occurrenceDateTime": "xyz789",
"occurrenceString": "xyz789",
"recorded": "abc123",
"primarySource": false,
"reportOrigin": CodeableConcept,
"location": Reference,
"manufacturer": Reference,
"lotNumber": "abc123",
"expirationDate": "abc123",
"site": CodeableConcept,
"route": CodeableConcept,
"doseQuantity": Quantity,
"performer": [ImmunizationPerformer],
"note": [Annotation],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"isSubpotent": true,
"subpotentReason": [CodeableConcept],
"education": [ImmunizationEducation],
"programEligibility": [CodeableConcept],
"fundingSource": CodeableConcept,
"reaction": [ImmunizationReaction],
"protocolApplied": [ImmunizationProtocolApplied]
}
]
}
}
Location
Example
Query
query Location($id: ID!) {
Location(id: $id) {
resourceType
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
status
operationalStatus {
...CodingFragment
}
name
alias
description
mode
type {
...CodeableConceptFragment
}
telecom {
...ContactPointFragment
}
address {
...AddressFragment
}
physicalType {
...CodeableConceptFragment
}
position {
...LocationPositionFragment
}
managingOrganization {
...ReferenceFragment
}
partOf {
...ReferenceFragment
}
hoursOfOperation {
...LocationHoursOfOperationFragment
}
availabilityExceptions
endpoint {
...ReferenceFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"Location": {
"resourceType": "xyz789",
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"status": "active",
"operationalStatus": Coding,
"name": "xyz789",
"alias": ["abc123"],
"description": "abc123",
"mode": "instance",
"type": [CodeableConcept],
"telecom": [ContactPoint],
"address": Address,
"physicalType": CodeableConcept,
"position": LocationPosition,
"managingOrganization": Reference,
"partOf": Reference,
"hoursOfOperation": [LocationHoursOfOperation],
"availabilityExceptions": "abc123",
"endpoint": [Reference]
}
}
}
MedicationAdministration
Response
Returns a MedicationAdministration
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query MedicationAdministration($id: ID!) {
MedicationAdministration(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiates
partOf {
...ReferenceFragment
}
status
statusReason {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
medicationCodeableConcept {
...CodeableConceptFragment
}
medicationReference {
...ReferenceFragment
}
subject {
...ReferenceFragment
}
context {
...ReferenceFragment
}
supportingInformation {
...ReferenceFragment
}
effectiveDateTime
effectivePeriod {
...PeriodFragment
}
performer {
...MedicationAdministrationPerformerFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
request {
...ReferenceFragment
}
device {
...ReferenceFragment
}
note {
...AnnotationFragment
}
dosage {
...MedicationAdministrationDosageFragment
}
eventHistory {
...ReferenceFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"MedicationAdministration": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "abc123",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiates": ["xyz789"],
"partOf": [Reference],
"status": "in_progress",
"statusReason": [CodeableConcept],
"category": CodeableConcept,
"medicationCodeableConcept": CodeableConcept,
"medicationReference": Reference,
"subject": Reference,
"context": Reference,
"supportingInformation": [Reference],
"effectiveDateTime": "xyz789",
"effectivePeriod": Period,
"performer": [MedicationAdministrationPerformer],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"request": Reference,
"device": [Reference],
"note": [Annotation],
"dosage": MedicationAdministrationDosage,
"eventHistory": [Reference]
}
}
}
MedicationAdministrationConnection
Response
Returns a MedicationAdministrationConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - MedicationAdministrationFilterParams!
|
Default = {} |
sort - MedicationAdministrationSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query MedicationAdministrationConnection(
$upid: ID!,
$filter: MedicationAdministrationFilterParams!,
$sort: MedicationAdministrationSortParams!,
$first: Int!,
$after: String!
) {
MedicationAdministrationConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MedicationAdministrationEdgeFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "sort": {}, "first": 10, "after": ""}
Response
{
"data": {
"MedicationAdministrationConnection": {
"pageInfo": PageInfo,
"edges": [MedicationAdministrationEdge]
}
}
}
MedicationAdministrationHistory
Response
Returns [MedicationAdministration!]
Example
Query
query MedicationAdministrationHistory(
$id: ID!,
$count: Int!
) {
MedicationAdministrationHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiates
partOf {
...ReferenceFragment
}
status
statusReason {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
medicationCodeableConcept {
...CodeableConceptFragment
}
medicationReference {
...ReferenceFragment
}
subject {
...ReferenceFragment
}
context {
...ReferenceFragment
}
supportingInformation {
...ReferenceFragment
}
effectiveDateTime
effectivePeriod {
...PeriodFragment
}
performer {
...MedicationAdministrationPerformerFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
request {
...ReferenceFragment
}
device {
...ReferenceFragment
}
note {
...AnnotationFragment
}
dosage {
...MedicationAdministrationDosageFragment
}
eventHistory {
...ReferenceFragment
}
}
}
Variables
{"id": 4, "count": 10}
Response
{
"data": {
"MedicationAdministrationHistory": [
{
"resourceType": "abc123",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiates": ["abc123"],
"partOf": [Reference],
"status": "in_progress",
"statusReason": [CodeableConcept],
"category": CodeableConcept,
"medicationCodeableConcept": CodeableConcept,
"medicationReference": Reference,
"subject": Reference,
"context": Reference,
"supportingInformation": [Reference],
"effectiveDateTime": "abc123",
"effectivePeriod": Period,
"performer": [MedicationAdministrationPerformer],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"request": Reference,
"device": [Reference],
"note": [Annotation],
"dosage": MedicationAdministrationDosage,
"eventHistory": [Reference]
}
]
}
}
MedicationAdministrationList
Response
Returns [MedicationAdministration!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - MedicationAdministrationFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query MedicationAdministrationList(
$upid: ID!,
$filter: MedicationAdministrationFilterParams!,
$_count: Int!
) {
MedicationAdministrationList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
instantiates
partOf {
...ReferenceFragment
}
status
statusReason {
...CodeableConceptFragment
}
category {
...CodeableConceptFragment
}
medicationCodeableConcept {
...CodeableConceptFragment
}
medicationReference {
...ReferenceFragment
}
subject {
...ReferenceFragment
}
context {
...ReferenceFragment
}
supportingInformation {
...ReferenceFragment
}
effectiveDateTime
effectivePeriod {
...PeriodFragment
}
performer {
...MedicationAdministrationPerformerFragment
}
reasonCode {
...CodeableConceptFragment
}
reasonReference {
...ReferenceFragment
}
request {
...ReferenceFragment
}
device {
...ReferenceFragment
}
note {
...AnnotationFragment
}
dosage {
...MedicationAdministrationDosageFragment
}
eventHistory {
...ReferenceFragment
}
}
}
Variables
{"upid": 4, "filter": {}, "_count": 10}
Response
{
"data": {
"MedicationAdministrationList": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "abc123",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"instantiates": ["abc123"],
"partOf": [Reference],
"status": "in_progress",
"statusReason": [CodeableConcept],
"category": CodeableConcept,
"medicationCodeableConcept": CodeableConcept,
"medicationReference": Reference,
"subject": Reference,
"context": Reference,
"supportingInformation": [Reference],
"effectiveDateTime": "xyz789",
"effectivePeriod": Period,
"performer": [MedicationAdministrationPerformer],
"reasonCode": [CodeableConcept],
"reasonReference": [Reference],
"request": Reference,
"device": [Reference],
"note": [Annotation],
"dosage": MedicationAdministrationDosage,
"eventHistory": [Reference]
}
]
}
}
MedicationDispense
Response
Returns a MedicationDispense
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query MedicationDispense($id: ID!) {
MedicationDispense(id: $id) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
partOf {
...ReferenceFragment
}
status
statusReasonCodeableConcept {
...CodeableConceptFragment
}
statusReasonReference {
...ReferenceFragment
}
category {
...CodeableConceptFragment
}
medicationCodeableConcept {
...CodeableConceptFragment
}
medicationReference {
...ReferenceFragment
}
subject {
...ReferenceFragment
}
context {
...ReferenceFragment
}
supportingInformation {
...ReferenceFragment
}
performer {
...MedicationDispensePerformerFragment
}
location {
...ReferenceFragment
}
authorizingPrescription {
...ReferenceFragment
}
type {
...CodeableConceptFragment
}
quantity {
...QuantityFragment
}
daysSupply {
...QuantityFragment
}
whenPrepared
whenHandedOver
destination {
...ReferenceFragment
}
receiver {
...ReferenceFragment
}
note {
...AnnotationFragment
}
dosageInstruction {
...DosageFragment
}
substitution {
...MedicationDispenseSubstitutionFragment
}
detectedIssue {
...ReferenceFragment
}
eventHistory {
...ReferenceFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"MedicationDispense": {
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": 4,
"meta": Meta,
"implicitRules": "xyz789",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"partOf": [Reference],
"status": "preparation",
"statusReasonCodeableConcept": CodeableConcept,
"statusReasonReference": Reference,
"category": CodeableConcept,
"medicationCodeableConcept": CodeableConcept,
"medicationReference": Reference,
"subject": Reference,
"context": Reference,
"supportingInformation": [Reference],
"performer": [MedicationDispensePerformer],
"location": Reference,
"authorizingPrescription": [Reference],
"type": CodeableConcept,
"quantity": Quantity,
"daysSupply": Quantity,
"whenPrepared": "xyz789",
"whenHandedOver": "xyz789",
"destination": Reference,
"receiver": [Reference],
"note": [Annotation],
"dosageInstruction": [Dosage],
"substitution": MedicationDispenseSubstitution,
"detectedIssue": [Reference],
"eventHistory": [Reference]
}
}
}
MedicationDispenseConnection
Response
Returns a MedicationDispenseConnection
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - MedicationDispenseFilterParams!
|
Default = {} |
sort - MedicationDispenseSortParams!
|
Default = {} |
first - Int!
|
Default = 10 |
after - String!
|
Default = "" |
Example
Query
query MedicationDispenseConnection(
$upid: ID!,
$filter: MedicationDispenseFilterParams!,
$sort: MedicationDispenseSortParams!,
$first: Int!,
$after: String!
) {
MedicationDispenseConnection(
upid: $upid,
filter: $filter,
sort: $sort,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MedicationDispenseEdgeFragment
}
}
}
Variables
{
"upid": "4",
"filter": {},
"sort": {},
"first": 10,
"after": ""
}
Response
{
"data": {
"MedicationDispenseConnection": {
"pageInfo": PageInfo,
"edges": [MedicationDispenseEdge]
}
}
}
MedicationDispenseHistory
Response
Returns [MedicationDispense!]
Example
Query
query MedicationDispenseHistory(
$id: ID!,
$count: Int!
) {
MedicationDispenseHistory(
id: $id,
count: $count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment
}
partOf {
...ReferenceFragment
}
status
statusReasonCodeableConcept {
...CodeableConceptFragment
}
statusReasonReference {
...ReferenceFragment
}
category {
...CodeableConceptFragment
}
medicationCodeableConcept {
...CodeableConceptFragment
}
medicationReference {
...ReferenceFragment
}
subject {
...ReferenceFragment
}
context {
...ReferenceFragment
}
supportingInformation {
...ReferenceFragment
}
performer {
...MedicationDispensePerformerFragment
}
location {
...ReferenceFragment
}
authorizingPrescription {
...ReferenceFragment
}
type {
...CodeableConceptFragment
}
quantity {
...QuantityFragment
}
daysSupply {
...QuantityFragment
}
whenPrepared
whenHandedOver
destination {
...ReferenceFragment
}
receiver {
...ReferenceFragment
}
note {
...AnnotationFragment
}
dosageInstruction {
...DosageFragment
}
substitution {
...MedicationDispenseSubstitutionFragment
}
detectedIssue {
...ReferenceFragment
}
eventHistory {
...ReferenceFragment
}
}
}
Variables
{"id": "4", "count": 10}
Response
{
"data": {
"MedicationDispenseHistory": [
{
"resourceType": "xyz789",
"ProvenanceList": [Provenance],
"id": "4",
"meta": Meta,
"implicitRules": "abc123",
"language": "xyz789",
"text": Narrative,
"contained": [Resource],
"extension": [Extension],
"modifierExtension": [Extension],
"identifier": [Identifier],
"partOf": [Reference],
"status": "preparation",
"statusReasonCodeableConcept": CodeableConcept,
"statusReasonReference": Reference,
"category": CodeableConcept,
"medicationCodeableConcept": CodeableConcept,
"medicationReference": Reference,
"subject": Reference,
"context": Reference,
"supportingInformation": [Reference],
"performer": [MedicationDispensePerformer],
"location": Reference,
"authorizingPrescription": [Reference],
"type": CodeableConcept,
"quantity": Quantity,
"daysSupply": Quantity,
"whenPrepared": "xyz789",
"whenHandedOver": "xyz789",
"destination": Reference,
"receiver": [Reference],
"note": [Annotation],
"dosageInstruction": [Dosage],
"substitution": MedicationDispenseSubstitution,
"detectedIssue": [Reference],
"eventHistory": [Reference]
}
]
}
}
MedicationDispenseList
Response
Returns [MedicationDispense!]
Arguments
Name | Description |
---|---|
upid - ID!
|
|
filter - MedicationDispenseFilterParams!
|
Default = {} |
_count - Int!
|
Default = 10 |
Example
Query
query MedicationDispenseList(
$upid: ID!,
$filter: MedicationDispenseFilterParams!,
$_count: Int!
) {
MedicationDispenseList(
upid: $upid,
filter: $filter,
_count: $_count
) {
resourceType
ProvenanceList {
...ProvenanceFragment
}
id
meta {
...MetaFragment
}
implicitRules
language
text {
...NarrativeFragment
}
contained {
...ResourceFragment
}
extension {
...ExtensionFragment
}
modifierExtension {
...ExtensionFragment
}
identifier {
...IdentifierFragment