----- BEGIN PAGE https://docs.canvasmedical.com/api/accessing-resource-attachment-files/
Several Canvas FHIR resources include a `url` attribute that points to an attachment file stored in S3. When you read or search these resources, the `url` value will be a `/files/` path on the Canvas FHIR server. Fetching that URL requires a **Bearer token** and returns a **redirect** to a pre-signed S3 URL that **expires after 10 minutes**.
There are two ways to retrieve the file, depending on whether you want the raw file content or the pre-signed URL itself.
##  Endpoints that return file URLs 
Resource | URL pattern  
---|---  
[Consent](/api/consent) | `GET /Consent/{id}/files/sourceAttachment`  
[DiagnosticReport](/api/diagnosticreport) | `GET /DiagnosticReport/{id}/files/presentedForm`  
[DocumentReference](/api/documentreference) | `GET /DocumentReference/{id}/files/content`  
[Media](/api/media) | `GET /Media/{id}/files/content`  
[Patient](/api/patient) | `GET /Patient/{id}/files/photo`  
[Practitioner](/api/practitioner) | `GET /Practitioner/{id}/files/signature`  
##  Option 1: Follow the redirect to get the file content 
The simplest approach is to let your HTTP client follow the redirect automatically. The pre-signed S3 URL contains its own authentication in the query parameters, so no additional headers are needed for the second request.
  - **curl**
        ```bash
        curl -L -o downloaded_file.pdf \
          -H "Authorization: Bearer $TOKEN" \
          "https://fumage-{instance}.canvasmedical.com/DocumentReference/abc123/files/content"
        ```
  - **python**
        ```python
        import requests
        base_url = "https://fumage-{instance}.canvasmedical.com"
        token = "your_bearer_token"
        file_url = f"{base_url}/DocumentReference/abc123/files/content"
        response = requests.get(
            file_url,
            headers={"Authorization": f"Bearer {token}"},
        )
        with open("downloaded_file.pdf", "wb") as f:
            f.write(response.content)
        ```
  - **javascript**
        ```javascript
        const response = await axios.get(url, {
          headers: { Authorization: `Bearer ${token}` },
          responseType: 'arraybuffer',
        });
        // response.data contains the raw file content
        writeFileSync('downloaded_file.pdf', Buffer.from(response.data));
        ```
##  Option 2: Capture the pre-signed URL without following the redirect 
If you need the pre-signed S3 URL itself — for example, to load it in an `<iframe>`, pass it to a frontend, or open it in a browser — you can configure your client to not follow redirects, and read the `Location` header in the response.
  - **curl**
        ```bash
        PRESIGNED_URL=$(curl -s -o /dev/null -w '%{redirect_url}' \
          -H "Authorization: Bearer $TOKEN" \
          "https://fumage-{instance}.canvasmedical.com/DocumentReference/abc123/files/content")
        echo "$PRESIGNED_URL"
        ```
  - **python**
        ```python
        import requests
        base_url = "https://fumage-{instance}.canvasmedical.com"
        token = "your_bearer_token"
        file_url = f"{base_url}/DocumentReference/abc123/files/content"
        response = requests.get(
            file_url,
            headers={"Authorization": f"Bearer {token}"},
            allow_redirects=False,
        )
        presigned_url = response.headers["Location"]
        # This URL works without auth and expires after 10 minutes
        ```
  - **javascript**
        ```javascript
        const response = await axios.get(url, {
          maxRedirects: 0,
          validateStatus: (status) => status === 307,
          headers: { Authorization: `Bearer ${token}` },
        });
        const presignedUrl = response.headers['location'];
        // This URL works without auth — use it in an iframe, open in browser, etc.
        ```
##  Note on HTTP client redirect behavior 
Per [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110#section-15.4), compliant HTTP clients should strip the `Authorization` header when following a redirect to a different host. However, some HTTP clients do not do this, which can cause S3 to reject the request with a dual-auth error:
    ```xml
    <Error>
      <Code>InvalidArgument</Code>
      <Message>Only one auth mechanism allowed; only the X-Amz-Algorithm
      query parameter or the Authorization header should be specified,
      not both.</Message>
    </Error>
    ```
If you encounter this error, your client is forwarding the Bearer token to S3. Use **Option 2** above to handle the redirect manually, or configure your client to strip authorization headers on cross-origin redirects.
----- END PAGE https://docs.canvasmedical.com/api/accessing-resource-attachment-files/


----- BEGIN PAGE https://docs.canvasmedical.com/api/allergen/
### 
A substance that, upon exposure to an individual, may cause a harmful or undesirable physiological response.   
Best practices is to utilize this endpoint to find codings to feed the [Allergy Intolerance Create/Update](/api/allergyintolerance/#create). These substances come directly from our integration with FDB.
### Endpoints
get /Allergen/{id} get /Allergen
get
/Allergen/{id}
#### Allergen read
Read an Allergen resource.
### Path Parameters
id required
string 
The unique identifier for the Allergen   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Allergen.
text 
json 
Text summary of the Allergen, for human interpretation.
Click to view child attributes
status 
All allergens returned from this endpoint will show a status of `generated` since this resource is generated from FDB.
div 
Limited xhtml content that contains the human readable text of the Allergen.
code 
json 
Code that identifies the allergen   
In Canvas we will return two different codings: one from FDB and one RxNorm
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://snomed.info/sct 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the allergen
display 
string 
The display name of the coding
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Allergen
#### Allergen search
Search for Allergen resources.
### Query Parameters
**An Allergen Search requires either a code or _text search parameter to perform.**
_text 
string 
Performs a case insensitive partial search on the narrative of the Allergen.
code 
string 
System url and code that identifies the allergen formatted like   
`system_url|code`.
**Search Values Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm|code
  - http://snomed.info/sct|code
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Allergen.
text 
json 
Text summary of the Allergen, for human interpretation.
Click to view child attributes
status 
All allergens returned from this endpoint will show a status of `generated` since this resource is generated from FDB.
div 
Limited xhtml content that contains the human readable text of the Allergen.
code 
json 
Code that identifies the allergen   
In Canvas we will return two different codings: one from FDB and one RxNorm
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://snomed.info/sct 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the allergen
display 
string 
The display name of the coding
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Allergen/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Allergen/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Allergen",
            "id": "fdb-6-2754",
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>minocycline HCl</p><p>6979</p>\"</div>"
            },
            "code": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "6-2754",
                        "display": "minocycline HCl"
                    },
                    {
                        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                        "code": "6979"
                    }
                ]
            }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Allergen resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Allergen?code=http://www.nlm.nih.gov/research/umls/rxnorm|6979' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Allergen?code=http://www.nlm.nih.gov/research/umls/rxnorm|6979"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Allergen?code=http%3A%2F%2Fwww.nlm.nih.gov%2Fresearch%2Fumls%2Frxnorm%7C6979&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Allergen?code=http%3A%2F%2Fwww.nlm.nih.gov%2Fresearch%2Fumls%2Frxnorm%7C6979&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Allergen?code=http%3A%2F%2Fwww.nlm.nih.gov%2Fresearch%2Fumls%2Frxnorm%7C6979&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Allergen",
                        "id": "fdb-6-2754",
                        "text": {
                            "status": "generated",
                            "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>minocycline HCl</p><p>6979</p>\"</div>"
                        },
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.fdbhealth.com/",
                                    "code": "6-2754",
                                    "display": "minocycline HCl"
                                },
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "6979"
                                }
                            ]
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/allergen/


----- BEGIN PAGE https://docs.canvasmedical.com/api/allergyintolerance/
### 
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-allergyintolerance.html>   
To learn more about documenting allergies in Canvas see [here](https://canvas-medical.help.usepylon.com/articles/9964004914-document-allergies).
### Endpoints
post /AllergyIntolerance get /AllergyIntolerance/{id} put /AllergyIntolerance/{id} get /AllergyIntolerance
post
/AllergyIntolerance
#### AllergyIntolerance create
Create an AllergyIntolerance resource.
### Attributes
resourceType 
string 
The FHIR Resource name.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note. If neither is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
clinicalStatus 
json required
The clinical status of the allergy or intolerance.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical 
code 
string required
The code of the clinical status.
**Value Options Supported:**
  - active 
  - inactive 
verificationStatus 
json required
Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-verification 
code 
string required
The code of the verification status.
**Value Options Supported:**
  - confirmed 
  - entered-in-error 
type 
enum [ allergy | intolerance ] required
Identification of the underlying physiological mechanism for the reaction risk.
code 
json required
Code that identifies the allergy or intolerance.
Supported codings for create interactions are obtained from the [Allergen search endpoint](/api/allergen/#search). At least one coding needs to be an FDB coding.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://www.fdbhealth.com/ 
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://snomed.info/sct 
code 
string required
The code of the allergen.
patient 
json required
Who the sensitivity is for.
Click to view child attributes
reference 
string required
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter when the allergy or intolerance was asserted.
Supply an encounter reference to be able to insert the allergy command into a specific note on the patient's timeline. If no encounter is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.   
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/086cd6fe-2c94-455d-a53e-6ff1c2652cae"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
onsetDateTime 
date 
When allergy or intolerance was identified.
recorder 
json 
Who recorded the sensitivity.   
In Canvas this will be the originator and committer of the allergy command.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
lastOccurrence 
date 
Date of last known occurrence of a reaction.   
This date will not appear in the Canvas UI and can only be supplied or read through FHIR.
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `reaction` field of the allergy command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string required
The annotation - text content.
reaction 
array[json] 
Adverse Reaction Events linked to exposure to substance. Only one reaction is supported.
Click to view child attributes
manifestation 
array[json] required
Clinical symptoms/signs associated with the Event.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string required
The code of the verification status.
**Value Options Supported:**
  - unknown 
severity 
string 
Clinical assessment of the severity of the reaction event as a whole.
**Value Options Supported:**
  - mild 
  - moderate 
  - severe 
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/AllergyIntolerance/{id}
#### AllergyIntolerance read
Read an AllergyIntolerance resource.
### Path Parameters
id required
string 
The unique identifier for the AllergyIntolerance   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the AllergyIntolerance.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
clinicalStatus 
json 
The clinical status of the allergy or intolerance.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical 
code 
string 
The code of the clinical status.
**Value Options Supported:**
  - active 
  - inactive 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Active 
  - Inactive 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Active 
  - Inactive 
verificationStatus 
json 
Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-verification 
code 
string 
The code of the verification status.
**Value Options Supported:**
  - confirmed 
  - entered-in-error 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
type 
enum [ allergy | intolerance ] 
Identification of the underlying physiological mechanism for the reaction risk.
code 
json 
Code that identifies the allergy or intolerance.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.fdbhealth.com/ 
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://snomed.info/sct 
code 
string 
The code of the allergen.
display 
string 
The display name of the coding.
patient 
json 
Who the sensitivity is for.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter when the allergy or intolerance was asserted.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/086cd6fe-2c94-455d-a53e-6ff1c2652cae"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
onsetDateTime 
date 
When allergy or intolerance was identified.
recordedDate 
datetime 
Date first version of the resource instance was recorded.
recorder 
json 
Who recorded the sensitivity.   
In Canvas this will be the originator and committer of the allergy command.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
lastOccurrence 
date 
Date of last known occurrence of a reaction.   
This date will not appear in the Canvas UI and can only be supplied or read through FHIR.
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `reaction` field of the allergy command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
reaction 
array[json] 
Adverse Reaction Events linked to exposure to substance. Only one reaction is supported.
Click to view child attributes
manifestation 
array[json] 
Clinical symptoms/signs associated with the Event.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string 
The code of the verification status.
**Value Options Supported:**
  - unknown 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Unknown 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Unknown 
severity 
string 
Clinical assessment of the severity of the reaction event as a whole.
**Value Options Supported:**
  - mild 
  - moderate 
  - severe 
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/AllergyIntolerance/{id}
#### AllergyIntolerance update
Update an AllergyIntolerance resource.  
The only type of AllergyIntolerance update interaction that is supported by Canvas is to mark an existing AllergyIntolerance as **entered-in-error** using the `verificationStatus` attribute. No changes to other fields will be processed; however, required fields still need to be supplied.
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the AllergyIntolerance.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
clinicalStatus 
json required
The clinical status of the allergy or intolerance.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical 
code 
string required
The code of the clinical status.
**Value Options Supported:**
  - active 
  - inactive 
verificationStatus 
json required
Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-verification 
code 
string required
The code of the verification status.
**Value Options Supported:**
  - confirmed 
  - entered-in-error 
type 
enum [ allergy | intolerance ] required
Identification of the underlying physiological mechanism for the reaction risk.
code 
json required
Code that identifies the allergy or intolerance.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://www.fdbhealth.com/ 
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://snomed.info/sct 
code 
string required
The code of the allergen.
patient 
json required
Who the sensitivity is for.
Click to view child attributes
reference 
string required
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter when the allergy or intolerance was asserted.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/086cd6fe-2c94-455d-a53e-6ff1c2652cae"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
onsetDateTime 
date 
When allergy or intolerance was identified.
recorder 
json 
Who recorded the sensitivity.   
In Canvas this will be the originator and committer of the allergy command.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
lastOccurrence 
date 
Date of last known occurrence of a reaction.   
This date will not appear in the Canvas UI and can only be supplied or read through FHIR.
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `reaction` field of the allergy command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string required
The annotation - text content.
reaction 
array[json] 
Adverse Reaction Events linked to exposure to substance. Only one reaction is supported.
Click to view child attributes
manifestation 
array[json] required
Clinical symptoms/signs associated with the Event.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string required
The code of the verification status.
**Value Options Supported:**
  - unknown 
severity 
string 
Clinical assessment of the severity of the reaction event as a whole.
**Value Options Supported:**
  - mild 
  - moderate 
  - severe 
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/AllergyIntolerance
#### AllergyIntolerance search
Search for AllergyIntolerance resources.
### Query Parameters
****
_id 
string 
The identifier of the AllergyIntolerance.
patient 
string 
The patient reference associated to the AllergyIntolerance in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the AllergyIntolerance.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
clinicalStatus 
json 
The clinical status of the allergy or intolerance.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical 
code 
string 
The code of the clinical status.
**Value Options Supported:**
  - active 
  - inactive 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Active 
  - Inactive 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Active 
  - Inactive 
verificationStatus 
json 
Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/allergyintolerance-verification 
code 
string 
The code of the verification status.
**Value Options Supported:**
  - confirmed 
  - entered-in-error 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
type 
enum [ allergy | intolerance ] 
Identification of the underlying physiological mechanism for the reaction risk.
code 
json 
Code that identifies the allergy or intolerance.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.fdbhealth.com/ 
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://snomed.info/sct 
code 
string 
The code of the allergen.
display 
string 
The display name of the coding.
patient 
json 
Who the sensitivity is for.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter when the allergy or intolerance was asserted.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/086cd6fe-2c94-455d-a53e-6ff1c2652cae"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
onsetDateTime 
date 
When allergy or intolerance was identified.
recordedDate 
datetime 
Date first version of the resource instance was recorded.
recorder 
json 
Who recorded the sensitivity.   
In Canvas this will be the originator and committer of the allergy command.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
lastOccurrence 
date 
Date of last known occurrence of a reaction.   
This date will not appear in the Canvas UI and can only be supplied or read through FHIR.
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `reaction` field of the allergy command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
reaction 
array[json] 
Adverse Reaction Events linked to exposure to substance. Only one reaction is supported.
Click to view child attributes
manifestation 
array[json] 
Clinical symptoms/signs associated with the Event.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string 
The code of the verification status.
**Value Options Supported:**
  - unknown 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Unknown 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Unknown 
severity 
string 
Clinical assessment of the severity of the reaction event as a whole.
**Value Options Supported:**
  - mild 
  - moderate 
  - severe 
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "AllergyIntolerance",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                        "code": "active",
                        "display": "Active"
                    }
                ],
                "text": "Active"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                        "code": "confirmed",
                        "display": "Confirmed"
                    }
                ],
                "text": "Confirmed"
            },
            "type": "allergy",
            "code": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "2-15588",
                        "display": "Allergy Medicine"
                    }
                ],
                "text": "Allergy Medicine"
            },
            "patient": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "lastOccurrence": "2023-06-17",
            "note": [
                {
                    "text": "AllergyIntolerance note"
                }
            ],
            "reaction": [
                {
                    "manifestation": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "unknown",
                                    "display": "Unknown"
                                }
                            ],
                            "text": "Unknown"
                        }
                    ],
                    "severity": "moderate"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/AllergyIntolerance"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "AllergyIntolerance",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                        "code": "active",
                        "display": "Active"
                    }
                ],
                "text": "Active"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                        "code": "confirmed",
                        "display": "Confirmed"
                    }
                ],
                "text": "Confirmed"
            },
            "type": "allergy",
            "code": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "2-15588",
                        "display": "Allergy Medicine"
                    }
                ],
                "text": "Allergy Medicine"
            },
            "patient": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "lastOccurrence": "2023-06-17",
            "note": [
                {
                    "text": "AllergyIntolerance note"
                }
            ],
            "reaction": [
                {
                    "manifestation": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "unknown",
                                    "display": "Unknown"
                                }
                            ],
                            "text": "Unknown"
                        }
                    ],
                    "severity": "moderate"
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "AllergyIntolerance",
            "id": "3340c331-d446-4700-9c23-7959bd393f26",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                        "code": "active",
                        "display": "Active"
                    }
                ],
                "text": "Active"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                        "code": "confirmed",
                        "display": "Confirmed"
                    }
                ],
                "text": "Confirmed"
            },
            "type": "allergy",
            "code": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "2-15588",
                        "display": "Allergy Medicine"
                    }
                ],
                "text": "Allergy Medicine"
            },
            "patient": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "lastOccurrence": "2023-06-17",
            "note": [
                {
                    "text": "AllergyIntolerance note"
                }
            ],
            "reaction": [
                {
                    "manifestation": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "unknown",
                                    "display": "Unknown"
                                }
                            ],
                            "text": "Unknown"
                        }
                    ],
                    "severity": "moderate"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown AllergyIntolerance resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "AllergyIntolerance",
             "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                        "code": "active",
                        "display": "Active"
                    }
                ],
                "text": "Active"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                        "code": "entered-in-error",
                        "display": "Entered in Error"
                    }
                ],
                "text": "Entered in Error"
            },
            "type": "allergy",
            "code": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "2-15588",
                        "display": "Allergy Medicine"
                    }
                ],
                "text": "Allergy Medicine"
            },
            "patient": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "lastOccurrence": "2023-06-17",
            "note": [
                {
                    "text": "AllergyIntolerance note"
                }
            ],
            "reaction": [
                {
                    "manifestation": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "unknown",
                                    "display": "Unknown"
                                }
                            ],
                            "text": "Unknown"
                        }
                    ],
                    "severity": "moderate"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "AllergyIntolerance",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                        "code": "active",
                        "display": "Active"
                    }
                ],
                "text": "Active"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                        "code": "entered-in-error",
                        "display": "Entered in Error"
                    }
                ],
                "text": "Entered in Error"
            },
            "type": "allergy",
            "code": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "2-15588",
                        "display": "Allergy Medicine"
                    }
                ],
                "text": "Allergy Medicine"
            },
            "patient": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "lastOccurrence": "2023-06-17",
            "note": [
                {
                    "text": "AllergyIntolerance note"
                }
            ],
            "reaction": [
                {
                    "manifestation": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "unknown",
                                    "display": "Unknown"
                                }
                            ],
                            "text": "Unknown"
                        }
                    ],
                    "severity": "moderate"
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown AllergyIntolerance resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/AllergyIntolerance?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "AllergyIntolerance",
                        "id": "3340c331-d446-4700-9c23-7959bd393f26",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                                "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                            }
                        ],
                        "clinicalStatus": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                                    "code": "active",
                                    "display": "Active"
                                }
                            ],
                            "text": "Active"
                        },
                        "verificationStatus": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                                    "code": "confirmed",
                                    "display": "Confirmed"
                                }
                            ],
                            "text": "Confirmed"
                        },
                        "type": "allergy",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.fdbhealth.com/",
                                    "code": "2-15588",
                                    "display": "Allergy Medicine"
                                }
                            ],
                            "text": "Allergy Medicine"
                        },
                        "patient": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
                        },
                        "encounter": {
                            "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
                        },
                        "onsetDateTime": "2023-06-15",
                        "recorder": {
                            "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
                        },
                        "lastOccurrence": "2023-06-17",
                        "note": [
                            {
                                "text": "AllergyIntolerance note"
                            }
                        ],
                        "reaction": [
                            {
                                "manifestation": [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                                "code": "unknown",
                                                "display": "Unknown"
                                            }
                                        ],
                                        "text": "Unknown"
                                    }
                                ],
                                "severity": "moderate"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/allergyintolerance/


----- BEGIN PAGE https://docs.canvasmedical.com/api/appointment/
### 
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).  
<https://hl7.org/fhir/R4/appointment.html>   
This may result in one or more [Encounters](/api/encounter).  
The appointment resource maps to both [patient appointments](https://canvas-medical.help.usepylon.com/articles/4617508394-appointment-management) as well as [other events](https://canvas-medical.help.usepylon.com/articles/4617508394-appointment-management#scheduling-other-events-30) in Canvas. Instructions for configuring event and note types can be found [here](https://canvas-medical.help.usepylon.com/articles/6785045644-appointment-event-note-types).
### Endpoints
post /Appointment get /Appointment/{id} put /Appointment/{id} get /Appointment
post
/Appointment
#### Appointment create
Create an **Appointment**  
It is recommended to utilize the [FHIR Slot Search](/api/slot#search) to find appointment times for a specific practitioner.  
**Prevent Double Booking** By default, Canvas does not prevent appointments from being created if there is already an existing appointment for that provider. However, Canvas has a config setting to disable double booking. If double booking is not allowed and the Appointment Create or Appointment Update request is trying to book an appointment for a given Provider that already has a scheduled appointment at that time, you will see a 422 error status with the following error message returned `This appointment time is no longer available.`
### Attributes
resourceType 
string 
The FHIR Resource name.
contained 
array[json] 
Contained, inline Resources. Used to store links for telehealth appointments.
This endpoint allows one custom video meeting link to be passed in that will be utilized on the UI over the default provider's meeting link if the appointment is a telemedicine. You can specify a telehealth meeting link by adding an element in the `SupportingInformation` attribute where the `SupportingInformation.reference` is `#appointment-meeting-endpoint-0` and matches the `contained[0].id` attribute of `appointment-meeting-endpoint-0`. See examples for help.
Click to view child attributes
resourceType 
enum [ Endpoint ] required
id 
string required
The `id` of the contained entry. This needs to be `appointment-meeting-endpoint-0` and the SupportingInformation.reference will be `#appointment-meeting-endpoint-0`.
address 
string required
The technical base address for connecting to this endpoint.
identifier 
array[json] 
External Ids for this item.   
The identifier list defines additional identifiers that are able to be stored for an appointment.  
These identifiers will not be surfaced on the Patient's chart, but they may help you identify the patient in your system by associating your identifier with the resource's `id`.
Click to view child attributes
use 
enum [ usual | official | temp | secondary | old ] 
The purpose of this identifier. If this is omitted, it will default to `usual`.
system 
string 
The namespace for the identifier value.
value 
string 
The value that is unique
assigner 
json 
Text representing Organization that issued id. If ommitted it will default to the system of the identifier.
Click to view child attributes
display 
string 
period 
json 
Time period when id is/was valid for use.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary. If omitted this will default to `1970-01-01`.
end 
datetime 
End time with inclusive boundary, if not ongoing. If ommitted this will default to `2100-12-31`.
status 
enum [ arrived | booked | cancelled | checked-in | fulfilled | noshow | pending | proposed ] required
The status of the appointment. The status `entered-in-error` may also be returned on read but is not accepted on create or update.   
This table shows the mappings of statuses/states an appointment is in within Canvas to the FHIR status attribute.   
FHIR Status | Canvas Status  
---|---  
proposed | unconfirmed  
pending | attempted  
booked | confirmed  
arrived | arrived  
checked-in | roomed  
fulfilled | exited  
noshow | noshowed  
cancelled | cancelled  
entered-in-error | deleted  
If any of the first 7 FHIR statuses are used, the appointment will appear on the schedule from the dropdown on the Appointment Card in the Schedule view with one of those statuses.   
An appointment can be created as `cancelled` for historical purposes, but it will not appear on the schedule view and will be a restorable note on the patient's timeline.   
The Create endpoint does NOT accept a status of `entered-in-error`.
appointmentType 
json 
The style of appointment or patient that has been booked in the slot (not service type). Canvas supports configurable [event and note types](https://canvas-medical.help.usepylon.com/articles/6785045644-appointment-event-note-types).
There are a few things to note with this attribute:   
1.If the `appointmentType` attribute is omitted from the body completely, the note type that has `Is default appointment type` will be used (usually Office Visit if unchanged)  
2.If the code / system pair does not exist, you will see a 422 error status with error message `Appointment Type does not exist with code: {code} and system: {system}`   
3.If the code / system pair passed is not marked as `Is Scheduleable` in Canvas, you will get a 422 error status with error message `Note type: {name} is not scheduleable`.
Click to view child attributes
coding 
array[json] 
The type of appointment
Click to view child attributes
system 
string 
The system of the appointment. On create and update, only `http://snomed.info/sct` and `INTERNAL` are accepted; other systems will be rejected.
**Value Options Supported:**
  - http://snomed.info/sct 
  - INTERNAL 
code 
string 
The code of the appointment.   
This needs to match a coding in the Event and Note Types Canvas Settings and be deemed as Is Scheduleable.
reasonCode 
array[json] 
Coded reason this appointment is scheduled.   
Canvas supports two ways to specify the reason for vist (RFV): [structured](/sdk/data-reason-for-visit/#reasonforvisitsettingcoding) and unstructured. Both the `coding` and `text` attributes are used for Structured RFVs, whereas unstructured RFVs only leverage the `text` attribute.
Canvas only accepts the first item in the reasonCode list.  
If you are taking advantage of our [structured reason for visit](/sdk/data-reason-for-visit/#reasonforvisitsettingcoding) feature, you can provide a `coding` that Canvas can use to look up the `code` value in configured in settings and display the structured RFV matching that code. If `Appointment.reasonCode[0].coding[0].code` is not a valid ReasonForVisitSettingCoding you will get the error "structured reason for visit with code {code} does not exist". You will also receive an error if the RFV code in Canvas' setting's page is not unique.   
The `text` attribute maps to the free text Reason For Visit command. If you are using the structured reason for visit feature, this text will display as the `comment` in the command. If you are not using the structured reason for visit feature, then only `Appointment.reasonCode[0].text` needs to be populated in your message and `coding` should be omitted.   
If this field is omitted (along with the deprecated `description` field), the RFV command in the appointment note will be defaulted to `No description given`.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
code 
string 
The code of the reason for visit.
text 
string 
description 
string 
Shown on a subject line in a meeting request, or appointment list.  
This description attribute is useful for Scheduled Events in Canvas that do no have a corresponding timeline entry.  
For appointments associated with a patient timeline entry, we strongly suggest using the `reasonCode` field to map to the Reason For Visit command in a Canvas Note. However, this descrition will match the reasonCode.text attribute in a Read/Search
supportingInformation 
array[json] required
Additional information to support the appointment. Currently, Canvas supports the ability to write 2 different types of references:   
  1. `Location`: A reference to a Location captures what Practice Location in Canvas the appointment will take place at.  
  2. `Meeting Link`: For appointments that are telehealth in Canvas, there can be a reference to an endpoint in this list. The reference attribute will need to match an `id` in the `Appointment.contained` attribute list, but will need to have a `#` in front of the reference string. See examples for help. For telehealth appointments where no meeting link reference is supplied, it will default to the practitioner's personal meeting room link as defined in Canvas Settings.
Click to view child attributes
reference 
string required
The reference string of the supporting information.
If the entry is for a Location the format will be `"Location/9d3a079f-22c0-4918-96d7-72eb567563ec"`. You can retrieve this information for a [Location Search](/api/location#search).  
If the entry is for a virtual meeting link, the reference should be `#appointment-meeting-endpoint-0`.
type 
string 
Type the reference refers to (e.g. "Location", "Endpoint", "Encounter", "Appointment").
start 
datetime required
When appointment is to take place.
The `start` attribute determines the start timestamp of the appointment. It is written in [instant format for FHIR](https://www.hl7.org/fhir/datatypes.html#instant). Seconds and milliseconds can be omitted, but YYYY-MM-DDTHH:MM are required.
end 
datetime required
When appointment is to conclude.
The end attribute is used with the start timestamp to determine the duration in minutes of the appointment. The duration of the appointment must be greater than 0 minutes. It is written in [instant format for FHIR](https://www.hl7.org/fhir/datatypes.html#instant). Seconds and milliseconds can be omitted, but YYYY-MM-DDTHH:MM are required.
participant 
array[json] required
Participants involved in appointment. At least one object needs to be supplied that corresponds to the practitioner, there will always be a practitioner involved in every appointment type. An optional 2nd object corresponding to the patient reference will be accepted if the `appointmentType` allows/requires a patient participant.
Click to view child attributes
actor 
json required
Reference to person involved in appointment.
Click to view child attributes
reference 
string required
The reference string of the practitioner or patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
**Value Options Supported:**
  - Practitioner/id 
  - Patient/id 
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
**Value Options Supported:**
  - Practitioner 
  - Patient 
status 
enum [ accepted ] required
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Appointment/{id}
#### Appointment read
Read an Appointment
### Path Parameters
id required
string 
The unique identifier for the Appointment   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the appointment.
contained 
array[json] 
Contained, inline Resources. Used to store links for telehealth appointments.
There will be a reference in the `supportingInformation` attribute with a `type` of `Endpoint` and a reference` of `#appointment-meeting-endpoint-0` that will match the `contained[0].id`.
Click to view child attributes
resourceType 
enum [ Endpoint ] 
id 
string 
The `id` of the contained entry. This needs to be `appointment-meeting-endpoint-0` and the SupportingInformation.reference will be `#appointment-meeting-endpoint-0`.
status 
enum [ active ] 
connectionType 
json 
Click to view child attributes
code 
string 
Protocol/Profile/Standard to be used with this endpoint connection
payloadType 
array[json] 
Click to view child attributes
coding 
array[json] 
Click to view child attributes
code 
enum [ video-call ] 
address 
string 
The technical base address for connecting to this endpoint.
extension 
array[json] 
Canvas supports a note identifier extension on this resource for read and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
identifier 
array[json] 
External Ids for this item.   
The identifier list defines additional identifiers that are able to be stored for an appointment.  
These identifiers will not be surfaced on the Patient's chart, but they may help you identify the patient in your system by associating your identifier with the resource's `id`.
Click to view child attributes
id 
string 
Unique id for inter-element referencing
use 
enum [ usual | official | temp | secondary | old ] 
The purpose of this identifier. If this is omitted, it will default to `usual`.
system 
string 
The namespace for the identifier value.
value 
string 
The value that is unique
period 
json 
Time period when id is/was valid for use.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary. If omitted this will default to `1970-01-01`.
end 
datetime 
End time with inclusive boundary, if not ongoing. If ommitted this will default to `2100-12-31`.
status 
enum [ arrived | booked | cancelled | checked-in | fulfilled | noshow | pending | proposed ] 
The status of the appointment. The status `entered-in-error` may also be returned on read but is not accepted on create or update.   
This table shows the mappings of statuses/states an appointment is in within Canvas to the FHIR status attribute.   
FHIR Status | Canvas Status  
---|---  
proposed | unconfirmed  
pending | attempted  
booked | confirmed  
arrived | arrived  
checked-in | roomed  
fulfilled | exited  
noshow | noshowed  
cancelled | cancelled  
entered-in-error | deleted  
The first 7 statuses come from the dropdown on the Appointment Card in the Schedule view. A `cancelled` status comes from a patient appointment or an other event being cancelled. The `deleted/entered-in-error` status is when a checked-in appointment note has been deleted in Canvas.
appointmentType 
json 
The style of appointment or patient that has been booked in the slot (not service type). Canvas supports configurable [event and note types](https://canvas-medical.help.usepylon.com/articles/6785045644-appointment-event-note-types).
Click to view child attributes
coding 
array[json] 
The type of appointment
Click to view child attributes
system 
string 
The system of the appointment
**Value Options Supported:**
  - http://snomed.info/sct 
  - INTERNAL 
code 
string 
The code of the appointment.   
This needs to match a coding in the Event and Note Types Canvas Settings and be deemed as Is Scheduleable.
display 
string 
The display of the appointment
reasonCode 
array[json] 
Coded reason this appointment is scheduled.   
Canvas supports two ways to specify the reason for vist (RFV): [structured](/sdk/data-reason-for-visit/#reasonforvisitsettingcoding) and unstructured. Both the `coding` and `text` attributes are used for Structured RFVs, whereas unstructured RFVs only leverage the `text` attribute.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system of the coding.
code 
string 
The code of the reason for visit.
display 
string 
The display name of the coding.
userSelected 
boolean 
If this coding was chosen directly by the user. In Canvas this indicates if the coding is currently active or not.
text 
string 
description 
string 
Shown on a subject line in a meeting request, or appointment list.  
This description attribute is useful for Scheduled Events in Canvas that do no have a corresponding timeline entry.  
For appointments associated with a patient timeline entry, we strongly suggest using the `reasonCode` field to map to the Reason For Visit command in a Canvas Note. However, this descrition will match the reasonCode.text attribute in a Read/Search
supportingInformation 
array[json] 
Additional information to support the appointment. Currently, Canvas supports different types of references in this list:   
  1. `Location`: A reference to a Location captures what Practice Location in Canvas the appointment will take place at.  
  2. `Meeting Link`: For appointments that are telehealth in Canvas, there will be a reference to an endpoint in this list. The reference attribute will match an `id` in the `Appointment.contained` attribute list. That element will display the url address of the virtual meeting link.   
  3. `Appointment`: If an appointment has been rescheduled, this list could display an associated Appointment reference. If you see a display of `Previously Rescheduled Appointment`, it means that the appointment you are currently looking at was created after rescheduling the appointment in that Reference. If you see a display of `Rescheduled Replacement Appointment`, it means that the appointment you are currently looking at is now outdated by a new appointment. If you see a display of `Co-scheduled Appointment`, it means that the appointment you are currently looking at was scheduled with other additional associated appointments for which the appointment reference ID is noted.   
  4. `Encounter`: If there is any encounter associated with the appointment made in Canvas, the reference will appear in this list.
Click to view child attributes
reference 
string 
The reference string of the supporting information.
type 
string 
Type the reference refers to (e.g. "Location", "Endpoint", "Encounter", "Appointment").
display 
string 
Display name of the reference
**Value Options Supported:**
  - Previously Rescheduled Appointment 
  - Rescheduled Replacement Appointment 
  - Co-scheduled Appointment 
start 
datetime 
When appointment is to take place.
end 
datetime 
When appointment is to conclude.
participant 
array[json] 
Participants involved in appointment. There will be at least one entry for a practitioner. An optional 2nd entry will display if the appointment involves a specific patient. This will be dictated by the `appointmentType` and if it relates to a generic event or a patient's appointment.
Click to view child attributes
actor 
json 
Reference to person involved in appointment.
Click to view child attributes
reference 
string 
The reference string of the practitioner or patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
**Value Options Supported:**
  - Practitioner/id 
  - Patient/id 
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
**Value Options Supported:**
  - Practitioner 
  - Patient 
status 
enum [ accepted ] 
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Appointment/{id}
#### Appointment update
This is almost identical to the [Appointment Create](/api/appointment/#create). You must include **all required fields** in the request body, even if only some fields are changing; omitting required fields will result in a validation error. Optional fields that are omitted will be ignored and left as they are currently set in the Canvas database.  
A FHIR Appointment update interaction behaves differently than a rescheduling workflow in the Canvas UI. FHIR updates will directly modify the Appointment referred to by the `id` rather than creating a new appointment.  
Canvas prevents updating the patient an appointment is already associated to. Best practice is to cancel the existing appointment and create a new appointment with the correct patient.
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the appointment.
contained 
array[json] 
Contained, inline Resources. Used to store links for telehealth appointments.
This endpoint allows one custom video meeting link to be passed in that will be utilized on the UI over the default provider's meeting link if the appointment is a telemedicine. You can specify a telehealth meeting link by adding an element in the `SupportingInformation` attribute where the `SupportingInformation.reference` is `#appointment-meeting-endpoint-0` and matches the `contained[0].id` attribute of `appointment-meeting-endpoint-0`. See examples for help.
Click to view child attributes
resourceType 
enum [ Endpoint ] required
id 
string required
The `id` of the contained entry. This needs to be `appointment-meeting-endpoint-0` and the SupportingInformation.reference will be `#appointment-meeting-endpoint-0`.
address 
string required
The technical base address for connecting to this endpoint.
identifier 
array[json] 
External Ids for this item.   
The identifier list defines additional identifiers that are able to be stored for an appointment.  
These identifiers will not be surfaced on the Patient's chart, but they may help you identify the patient in your system by associating your identifier with the resource's `id`.
To update an existing `identifier`, include the `id` in the `identifier[x].id` field returned from Read/Search.  
The `identifier` section sent in an update will entirely replace existing identifiers currently within the period.start and period.end dates.  
If an `identifier` already exists in the Canvas database and is not included in the Update message, it will be deleted if and only if the period.end date is in the future.
Click to view child attributes
id 
string 
Unique id for inter-element referencing
use 
enum [ usual | official | temp | secondary | old ] 
The purpose of this identifier. If this is omitted, it will default to `usual`.
system 
string 
The namespace for the identifier value.
value 
string 
The value that is unique
assigner 
json 
Text representing Organization that issued id. If ommitted it will default to the system of the identifier.
Click to view child attributes
display 
string 
period 
json 
Time period when id is/was valid for use.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary. If omitted this will default to `1970-01-01`.
end 
datetime 
End time with inclusive boundary, if not ongoing. If ommitted this will default to `2100-12-31`.
status 
enum [ arrived | booked | cancelled | checked-in | fulfilled | noshow | pending | proposed ] required
The status of the appointment. The status `entered-in-error` may also be returned on read but is not accepted on create or update.   
This table shows the mappings of statuses/states an appointment is in within Canvas to the FHIR status attribute.   
FHIR Status | Canvas Status  
---|---  
proposed | unconfirmed  
pending | attempted  
booked | confirmed  
arrived | arrived  
checked-in | roomed  
fulfilled | exited  
noshow | noshowed  
cancelled | cancelled  
entered-in-error | deleted  
If any of the first 7 FHIR statuses are used, the appointment will appear on the schedule from the dropdown on the Appointment Card in the Schedule view with one of those statuses.   
An appointment can be updated to `cancelled` and as a result it will disappear from the schedule view and/or will be a restorable note on the patient's timeline. Once an appointment is in a cancelled state, it should not be updated to a different status via FHIR, instead the note should be reverted directly in the Patient's chart before it can be updated via FHIR again.   
The Update endpoint does NOT accept a status of `entered-in-error`.
appointmentType 
json 
The style of appointment or patient that has been booked in the slot (not service type). Canvas supports configurable [event and note types](https://canvas-medical.help.usepylon.com/articles/6785045644-appointment-event-note-types).
There are a few things to note with this attribute:   
  1. If the `appointmentType` is an Other Event that does not require a patient, you must provide the `appointmentType` in the upload payload to pass validation.   
  2. For all appointments that require a patient, if the `appointmentType` attribute is omitted from the body completely on an update, the note type will stay as it already is in Canvas.  
  3. If the code / system pair does not exist, you will see a 422 error status with error message `Appointment Type does not exist with code: {code} and system: {system}`   
  4. If the code / system pair passed is not marked as `Is Scheduleable` in Canvas, you will get a 422 error status with error message `Note type: {name} is not scheduleable`.
Click to view child attributes
coding 
array[json] 
The type of appointment
Click to view child attributes
system 
string 
The system of the appointment. On create and update, only `http://snomed.info/sct` and `INTERNAL` are accepted; other systems will be rejected.
**Value Options Supported:**
  - http://snomed.info/sct 
  - INTERNAL 
code 
string 
The code of the appointment.   
This needs to match a coding in the Event and Note Types Canvas Settings and be deemed as Is Scheduleable.
reasonCode 
array[json] 
Coded reason this appointment is scheduled.   
Canvas supports two ways to specify the reason for vist (RFV): [structured](/sdk/data-reason-for-visit/#reasonforvisitsettingcoding) and unstructured. Both the `coding` and `text` attributes are used for Structured RFVs, whereas unstructured RFVs only leverage the `text` attribute.
On an update, if the reasonCode has changed from what is already saved in Canvas, it will create a new RFV command on that appointment. The old reason for visit will be marked as entered-in-error, and the text will no longer display. Below is an example of what an appointment's note will look like after changing the description multiple times. The originator and entered-in-error will be set to Canvas Bot, which can be seen if you click on the crossed off "Reason for Visit".  
![api-update-rfv](/assets/images/api-update-rfv.png)  
If this field is omitted (along with the deprecated `description` field), the RFV command in the appointment note will stay as it currently is.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
code 
string 
The code of the reason for visit.
text 
string 
description 
string 
Shown on a subject line in a meeting request, or appointment list.  
This description attribute is useful for Scheduled Events in Canvas that do no have a corresponding timeline entry.  
For appointments associated with a patient timeline entry, we strongly suggest using the `reasonCode` field to map to the Reason For Visit command in a Canvas Note. However, this descrition will match the reasonCode.text attribute in a Read/Search
supportingInformation 
array[json] required
Additional information to support the appointment. Currently, Canvas supports the ability to write 2 different types of references:   
  1. `Location`: A reference to a Location captures what Practice Location in Canvas the appointment will take place at.  
  2. `Meeting Link`: For appointments that are telehealth in Canvas, there can be a reference to an endpoint in this list. The reference attribute will need to match an `id` in the `Appointment.contained` attribute list, but will need to have a `#` in front of the reference string. See examples for help. For telehealth appointments where no meeting link reference is supplied, it will default to the practitioner's personal meeting room link as defined in Canvas Settings.
Click to view child attributes
reference 
string required
The reference string of the supporting information.
If the entry is for a Location the format will be `"Location/9d3a079f-22c0-4918-96d7-72eb567563ec"`. You can retrieve this information for a [Location Search](/api/location#search).  
If the entry is for a virtual meeting link, the reference should be `#appointment-meeting-endpoint-0`.
type 
string 
Type the reference refers to (e.g. "Location", "Endpoint", "Encounter", "Appointment").
start 
datetime required
When appointment is to take place.
The `start` attribute determines the start timestamp of the appointment. It is written in [instant format for FHIR](https://www.hl7.org/fhir/datatypes.html#instant). Seconds and milliseconds can be omitted, but YYYY-MM-DDTHH:MM are required.
end 
datetime required
When appointment is to conclude.
participant 
array[json] required
Participants involved in appointment. At least one object needs to be supplied that corresponds to the practitioner, there will always be a practitioner involved in every appointment type. An optional 2nd object corresponding to the patient reference will be accepted if the `appointmentType` allows/requires a patient participant.
Click to view child attributes
actor 
json required
Reference to person involved in appointment.
Click to view child attributes
reference 
string required
The reference string of the practitioner or patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
While the patient is a required attribute, if you try to change the patient from what is already in Canvas, you will get the error message "Cannot change patient for an existing appointment. Please cancel this appointment and create a new one for the new patient."
**Value Options Supported:**
  - Practitioner/id 
  - Patient/id 
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
**Value Options Supported:**
  - Practitioner 
  - Patient 
status 
enum [ accepted ] required
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Appointment
#### Appointment search
Search for an Appointment
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier for the Appointment.
appointment-type 
string 
Filters by the code and/or system under `appointmentType.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g `http://snomed.info/sct|308335008`).
identifier 
string 
Filters appointments by their external identifiers. You can search by just the identifier value or by using the format `system|value` (e.g. `NIST-MPI-1|171122`).
location 
string 
The location of the appointment in the format `Location/9d3a079f-22c0-4918-96d7-72eb567563ec`.
patient 
string 
The patient the appointment is for in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
practitioner 
string 
The practitioner involoved in the appointment in the format `Practitioner/3a9cafb9d1b445be95a2e2548e12a787`.
date 
string 
Filter by start time. See [Date Filtering](/api/date-filtering) for more information.
status 
string 
The status of the appointment.
**Search Values Supported:**
  - proposed
  - pending
  - booked
  - arrived
  - checked-in
  - fulfilled
  - noshow
  - cancelled
_sort 
string 
Triggers sorting of the results by a specific criteria. Adding a `-` will sort in descending order while the default sorts in ascending order.
**Search Values Supported:**
  - date
  - patient
  - practitioner
  - -date
  - -patient
  - -practitioner
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the appointment.
contained 
array[json] 
Contained, inline Resources. Used to store links for telehealth appointments.
There will be a reference in the `supportingInformation` attribute with a `type` of `Endpoint` and a reference` of `#appointment-meeting-endpoint-0` that will match the `contained[0].id`.
Click to view child attributes
resourceType 
enum [ Endpoint ] 
id 
string 
The `id` of the contained entry. This needs to be `appointment-meeting-endpoint-0` and the SupportingInformation.reference will be `#appointment-meeting-endpoint-0`.
status 
enum [ active ] 
connectionType 
json 
Click to view child attributes
code 
string 
Protocol/Profile/Standard to be used with this endpoint connection
payloadType 
array[json] 
Click to view child attributes
coding 
array[json] 
Click to view child attributes
code 
enum [ video-call ] 
address 
string 
The technical base address for connecting to this endpoint.
extension 
array[json] 
Canvas supports a note identifier extension on this resource for read and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
identifier 
array[json] 
External Ids for this item.   
The identifier list defines additional identifiers that are able to be stored for an appointment.  
These identifiers will not be surfaced on the Patient's chart, but they may help you identify the patient in your system by associating your identifier with the resource's `id`.
Click to view child attributes
id 
string 
Unique id for inter-element referencing
use 
enum [ usual | official | temp | secondary | old ] 
The purpose of this identifier. If this is omitted, it will default to `usual`.
system 
string 
The namespace for the identifier value.
value 
string 
The value that is unique
period 
json 
Time period when id is/was valid for use.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary. If omitted this will default to `1970-01-01`.
end 
datetime 
End time with inclusive boundary, if not ongoing. If ommitted this will default to `2100-12-31`.
status 
enum [ arrived | booked | cancelled | checked-in | fulfilled | noshow | pending | proposed ] 
The status of the appointment. The status `entered-in-error` may also be returned on read but is not accepted on create or update.   
This table shows the mappings of statuses/states an appointment is in within Canvas to the FHIR status attribute.   
FHIR Status | Canvas Status  
---|---  
proposed | unconfirmed  
pending | attempted  
booked | confirmed  
arrived | arrived  
checked-in | roomed  
fulfilled | exited  
noshow | noshowed  
cancelled | cancelled  
entered-in-error | deleted  
The first 7 statuses come from the dropdown on the Appointment Card in the Schedule view. A `cancelled` status comes from a patient appointment or an other event being cancelled. The `deleted/entered-in-error` status is when a checked-in appointment note has been deleted in Canvas.
appointmentType 
json 
The style of appointment or patient that has been booked in the slot (not service type). Canvas supports configurable [event and note types](https://canvas-medical.help.usepylon.com/articles/6785045644-appointment-event-note-types).
Click to view child attributes
coding 
array[json] 
The type of appointment
Click to view child attributes
system 
string 
The system of the appointment
**Value Options Supported:**
  - http://snomed.info/sct 
  - INTERNAL 
code 
string 
The code of the appointment.   
This needs to match a coding in the Event and Note Types Canvas Settings and be deemed as Is Scheduleable.
display 
string 
The display of the appointment
reasonCode 
array[json] 
Coded reason this appointment is scheduled.   
Canvas supports two ways to specify the reason for vist (RFV): [structured](/sdk/data-reason-for-visit/#reasonforvisitsettingcoding) and unstructured. Both the `coding` and `text` attributes are used for Structured RFVs, whereas unstructured RFVs only leverage the `text` attribute.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system of the coding.
code 
string 
The code of the reason for visit.
display 
string 
The display name of the coding.
userSelected 
boolean 
If this coding was chosen directly by the user. In Canvas this indicates if the coding is currently active or not.
text 
string 
description 
string 
Shown on a subject line in a meeting request, or appointment list.  
This description attribute is useful for Scheduled Events in Canvas that do no have a corresponding timeline entry.  
For appointments associated with a patient timeline entry, we strongly suggest using the `reasonCode` field to map to the Reason For Visit command in a Canvas Note. However, this descrition will match the reasonCode.text attribute in a Read/Search
supportingInformation 
array[json] 
Additional information to support the appointment. Currently, Canvas supports different types of references in this list:   
  1. `Location`: A reference to a Location captures what Practice Location in Canvas the appointment will take place at.  
  2. `Meeting Link`: For appointments that are telehealth in Canvas, there will be a reference to an endpoint in this list. The reference attribute will match an `id` in the `Appointment.contained` attribute list. That element will display the url address of the virtual meeting link.   
  3. `Appointment`: If an appointment has been rescheduled, this list could display an associated Appointment reference. If you see a display of `Previously Rescheduled Appointment`, it means that the appointment you are currently looking at was created after rescheduling the appointment in that Reference. If you see a display of `Rescheduled Replacement Appointment`, it means that the appointment you are currently looking at is now outdated by a new appointment. If you see a display of `Co-scheduled Appointment`, it means that the appointment you are currently looking at was scheduled with other additional associated appointments for which the appointment reference ID is noted.   
  4. `Encounter`: If there is any encounter associated with the appointment made in Canvas, the reference will appear in this list.
Click to view child attributes
reference 
string 
The reference string of the supporting information.
type 
string 
Type the reference refers to (e.g. "Location", "Endpoint", "Encounter", "Appointment").
display 
string 
Display name of the reference
**Value Options Supported:**
  - Previously Rescheduled Appointment 
  - Rescheduled Replacement Appointment 
  - Co-scheduled Appointment 
start 
datetime 
When appointment is to take place.
end 
datetime 
When appointment is to conclude.
participant 
array[json] 
Participants involved in appointment. There will be at least one entry for a practitioner. An optional 2nd entry will display if the appointment involves a specific patient. This will be dictated by the `appointmentType` and if it relates to a generic event or a patient's appointment.
Click to view child attributes
actor 
json 
Reference to person involved in appointment.
Click to view child attributes
reference 
string 
The reference string of the practitioner or patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
**Value Options Supported:**
  - Practitioner/id 
  - Patient/id 
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
**Value Options Supported:**
  - Practitioner 
  - Patient 
status 
enum [ accepted ] 
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Appointment/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Appointment/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Appointment",
            "id": "621a66fc-9d5c-4de0-97fb-935d611ac176",
            "contained":
            [
                {
                    "resourceType": "Endpoint",
                    "id": "appointment-meeting-endpoint-0",
                    "status": "active",
                    "connectionType":
                    {
                        "code": "https"
                    },
                    "payloadType":
                    [
                        {
                            "coding":
                            [
                                {
                                    "code": "video-call"
                                }
                            ]
                        }
                    ],
                    "address": "https://url-for-video-chat.example.com?meeting=abc123"
                }
            ],
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "identifier": [
                {
                    "id": "97b28298-f618-4972-9a6b-d095785587d6",
                    "use": "usual",
                    "system": "AssigningSystem",
                    "value": "test123",
                    "period": {
                        "start": "2024-01-01",
                        "end": "2024-12-31"
                    }
                }
            ],
            "status": "proposed",
            "appointmentType":
            {
                "coding":
                [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "448337001",
                        "display": "Telemedicine"
                    }
                ]
            },
            "reasonCode":
            [
                {
                    "coding":
                    [
                        {
                            "system": "INTERNAL",
                            "code": "INIV",
                            "display": "Initial Visit",
                            "userSelected": false
                        }
                    ],
                    "text": "Initial 30 Minute Visit"
                }
            ],
            "description": "Initial 30 Minute Visit",
            "supportingInformation":
            [
                {
                    "reference": "Location/b3476a18-3f63-422d-87e7-b3dc0cd55060",
                    "type": "Location"
                },
                {
                    "reference": "#appointment-meeting-endpoint-0",
                    "type": "Endpoint"
                },
                {
                    "reference": "Encounter/23668e1a-e914-4eac-885c-1a2a27244ab7",
                    "type": "Encounter"
                },
                {
                    "reference": "Appointment/7fa2874e-73c8-418d-bb25-eea0ccac651c",
                    "type": "Appointment",
                    "display": "Co-scheduled appointment"
                }
            ],
            "start": "2023-10-24T13:30:00+00:00",
            "end": "2023-10-24T14:00:00+00:00",
            "participant":
            [
                {
                    "actor":
                    {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner"
                    },
                    "status": "accepted"
                },
                {
                    "actor":
                    {
                        "reference": "Patient/ee1c7803325b47b492008f3e7c9d7a3d",
                        "type": "Patient"
                    },
                    "status": "accepted"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Appointment resource 'a47c7b0ebbb442cdbc4adf259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Appointment?patient=Patient/a031d1ba40d74aebb8ed716716da05c2&practitioner=Practitioner/4150cd20de8a470aa570a852859ac87e' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Appointment?patient=Patient/a031d1ba40d74aebb8ed716716da05c2&practitioner=Practitioner/4150cd20de8a470aa570a852859ac87e"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link":
            [
                {
                    "relation": "self",
                    "url": "/Appointment?patient=Patient%2Fa031d1ba40d74aebb8ed716716da05c2&practitioner=Practitioner%2F4150cd20de8a470aa570a852859ac87e&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Appointment?patient=Patient%2Fa031d1ba40d74aebb8ed716716da05c2&practitioner=Practitioner%2F4150cd20de8a470aa570a852859ac87e&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Appointment?patient=Patient%2Fa031d1ba40d74aebb8ed716716da05c2&practitioner=Practitioner%2F4150cd20de8a470aa570a852859ac87e&_count=10&_offset=0"
                }
            ],
            "entry":
            [
                {
                    "resource":
                    {
                        "resourceType": "Appointment",
                        "id": "f7bb6d7e-1cab-42cd-b3d2-40229e1bede7",
                        "contained":
                        [
                            {
                                "resourceType": "Endpoint",
                                "id": "appointment-meeting-endpoint-0",
                                "status": "active",
                                "connectionType":
                                {
                                    "code": "https"
                                },
                                "payloadType":
                                [
                                    {
                                        "coding":
                                        [
                                            {
                                                "code": "video-call"
                                            }
                                        ]
                                    }
                                ],
                                "address": "https://url-for-video-chat.example.com?meeting=abc123"
                            }
                        ],
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                                "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                            }
                        ],
                        "identifier": [
                          {
                              "id": "97b28298-f618-4972-9a6b-d095785587d6",
                              "use": "usual",
                              "system": "AssigningSystem",
                              "value": "test123",
                              "period": {
                                  "start": "2024-01-01",
                                  "end": "2024-12-31"
                              }
                          }
                        ],
                        "status": "proposed",
                        "appointmentType":
                        {
                            "coding":
                            [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "448337001",
                                    "display": "Telemedicine"
                                }
                            ]
                        },
                        "reasonCode":
                        [
                            {
                                "coding":
                                [
                                    {
                                        "system": "INTERNAL",
                                        "code": "INIV",
                                        "display": "Initial Visit",
                                        "userSelected": false
                                    }
                                ],
                                "text": "Initial 30 Minute Visit"
                            }
                        ],
                        "description": "Initial 30 Minute Visit",
                        "supportingInformation":
                        [
                            {
                                "reference": "Location/b3476a18-3f63-422d-87e7-b3dc0cd55060",
                                "type": "Location"
                            },
                            {
                                "reference": "#appointment-meeting-endpoint-0",
                                "type": "Endpoint"
                            },
                            {
                                "reference": "Encounter/797ccaae-2939-4e8a-9d91-5e9574a11a4e",
                                "type": "Encounter"
                            }
                        ],
                        "start": "2023-10-24T13:30:00+00:00",
                        "end": "2023-10-24T14:00:00+00:00",
                        "participant":
                        [
                            {
                                "actor":
                                {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner"
                                },
                                "status": "accepted"
                            },
                            {
                                "actor":
                                {
                                    "reference": "Patient/a031d1ba40d74aebb8ed716716da05c2",
                                    "type": "Patient"
                                },
                                "status": "accepted"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Appointment' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Appointment",
            "contained":
            [
                {
                    "resourceType": "Endpoint",
                    "id": "appointment-meeting-endpoint",
                    "status": "active",
                    "connectionType":
                    {
                        "code": "https"
                    },
                    "payloadType":
                    [
                        {
                            "coding":
                            [
                                {
                                    "code": "video-call"
                                }
                            ]
                        }
                    ],
                    "address": "https://url-for-video-chat.example.com?meeting=abc123"
                }
            ],
            "identifier": [
                {
                    "use": "usual",
                    "system": "AssigningSystem",
                    "value": "test123",
                    "period": {
                        "start": "2024-01-01",
                        "end": "2024-12-31"
                    }
                }
            ],
            "status": "proposed",
            "appointmentType":
            {
                "coding":
                [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "448337001",
                        "display": "Telemedicine consultation with patient (procedure)"
                    }
                ]
            },
            "reasonCode":
            [
                {
                    "coding":
                    [
                        {
                            "system": "INTERNAL",
                            "code": "INIV",
                            "display": "Initial Visit",
                            "userSelected": false
                        }
                    ],
                    "text": "Initial 30 Minute Visit"
                }
            ],
            "supportingInformation":
            [
                {
                    "reference": "Location/b3476a18-3f63-422d-87e7-b3dc0cd55060"
                },
                {
                    "reference": "#appointment-meeting-endpoint",
                    "type": "Endpoint"
                }
            ],
            "start": "2023-10-24T13:30:00.000Z",
            "end": "2023-10-24T14:00:00.000Z",
            "participant":
            [
                {
                    "actor":
                    {
                        "reference": "Patient/ee1c7803325b47b492008f3e7c9d7a3d"
                    },
                    "status": "accepted"
                },
                {
                    "actor":
                    {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e"
                    },
                    "status": "accepted"
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Appointment"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Appointment",
            "contained":
            [
                {
                    "resourceType": "Endpoint",
                    "id": "appointment-meeting-endpoint",
                    "status": "active",
                    "connectionType":
                    {
                        "code": "https"
                    },
                    "payloadType":
                    [
                        {
                            "coding":
                            [
                                {
                                    "code": "video-call"
                                }
                            ]
                        }
                    ],
                    "address": "https://url-for-video-chat.example.com?meeting=abc123"
                }
            ],
            "identifier": [
              {
                  "use": "usual",
                  "system": "AssigningSystem",
                  "value": "test123",
                  "period": {
                      "start": "2024-01-01",
                      "end": "2024-12-31"
                  }
              }
            ],
            "status": "proposed",
            "appointmentType":
            {
                "coding":
                [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "448337001",
                        "display": "Telemedicine consultation with patient (procedure)"
                    }
                ]
            },
            "reasonCode":
            [
                {
                    "coding":
                    [
                        {
                            "system": "INTERNAL",
                            "code": "INIV",
                            "display": "Initial Visit",
                            "userSelected": False
                        }
                    ],
                    "text": "Initial 30 Minute Visit"
                }
            ],
            "supportingInformation":
            [
                {
                    "reference": "Location/b3476a18-3f63-422d-87e7-b3dc0cd55060"
                },
                {
                    "reference": "#appointment-meeting-endpoint",
                    "type": "Endpoint"
                }
            ],
            "start": "2023-10-24T13:30:00.000Z",
            "end": "2023-10-24T14:00:00.000Z",
            "participant":
            [
                {
                    "actor":
                    {
                        "reference": "Patient/ee1c7803325b47b492008f3e7c9d7a3d"
                    },
                    "status": "accepted"
                },
                {
                    "actor":
                    {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e"
                    },
                    "status": "accepted"
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Appointment/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Appointment",
            "contained":
            [
                {
                    "resourceType": "Endpoint",
                    "id": "appointment-meeting-endpoint",
                    "status": "active",
                    "connectionType":
                    {
                        "code": "https"
                    },
                    "payloadType":
                    [
                        {
                            "coding":
                            [
                                {
                                    "code": "video-call"
                                }
                            ]
                        }
                    ],
                    "address": "https://url-for-video-chat.example.com?meeting=abc123"
                }
            ],
            "identifier": [
              {
                  "id": "97b28298-f618-4972-9a6b-d095785587d6",
                  "use": "usual",
                  "system": "AssigningSystem",
                  "value": "test123",
                  "period": {
                      "start": "2024-01-01",
                      "end": "2024-12-31"
                  }
              }
            ],
            "status": "cancelled",
            "appointmentType":
            {
                "coding":
                [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "448337001",
                        "display": "Telemedicine consultation with patient (procedure)"
                    }
                ]
            },
            "reasonCode":
            [
                {
                    "coding":
                    [
                        {
                            "system": "INTERNAL",
                            "code": "INIV",
                            "display": "Initial Visit",
                            "userSelected": false
                        }
                    ],
                    "text": "Initial 30 Minute Visit"
                }
            ],
            "supportingInformation":
            [
                {
                    "reference": "Location/b3476a18-3f63-422d-87e7-b3dc0cd55060"
                },
                {
                    "reference": "#appointment-meeting-endpoint",
                    "type": "Endpoint"
                }
            ],
            "start": "2023-10-24T13:30:00.000Z",
            "end": "2023-10-24T14:00:00.000Z",
            "participant":
            [
                {
                    "actor":
                    {
                        "reference": "Patient/ee1c7803325b47b492008f3e7c9d7a3d"
                    },
                    "status": "accepted"
                },
                {
                    "actor":
                    {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e"
                    },
                    "status": "accepted"
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Appointment/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Appointment",
            "contained":
            [
                {
                    "resourceType": "Endpoint",
                    "id": "appointment-meeting-endpoint",
                    "status": "active",
                    "connectionType":
                    {
                        "code": "https"
                    },
                    "payloadType":
                    [
                        {
                            "coding":
                            [
                                {
                                    "code": "video-call"
                                }
                            ]
                        }
                    ],
                    "address": "https://url-for-video-chat.example.com?meeting=abc123"
                }
            ],
            "identifier": [
              {
                  "id": "97b28298-f618-4972-9a6b-d095785587d6",
                  "use": "usual",
                  "system": "AssigningSystem",
                  "value": "test123",
                  "period": {
                      "start": "2024-01-01",
                      "end": "2024-12-31"
                  }
              }
            ],
            "status": "cancelled",
            "appointmentType":
            {
                "coding":
                [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "448337001",
                        "display": "Telemedicine consultation with patient (procedure)"
                    }
                ]
            },
            "reasonCode":
            [
                {
                    "coding":
                    [
                        {
                            "system": "INTERNAL",
                            "code": "INIV",
                            "display": "Initial Visit",
                            "userSelected": False
                        }
                    ],
                    "text": "Initial 30 Minute Visit"
                }
            ],
            "supportingInformation":
            [
                {
                    "reference": "Location/b3476a18-3f63-422d-87e7-b3dc0cd55060"
                },
                {
                    "reference": "#appointment-meeting-endpoint",
                    "type": "Endpoint"
                }
            ],
            "start": "2023-10-24T13:30:00.000Z",
            "end": "2023-10-24T14:00:00.000Z",
            "participant":
            [
                {
                    "actor":
                    {
                        "reference": "Patient/ee1c7803325b47b492008f3e7c9d7a3d"
                    },
                    "status": "accepted"
                },
                {
                    "actor":
                    {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e"
                    },
                    "status": "accepted"
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Appointment resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/appointment/


----- BEGIN PAGE https://docs.canvasmedical.com/api/authentication-best-practices/
##  Introduction 
The OAuth 2.0 authentication/authorization flow differs from the traditional username/password flow still heavily used in healthcare interoperability. To help users new to writing applications using OAuth, here are some best practices recommended by Canvas.
###  The Access Token: Don't lose it, reuse it 
####  Instead of this 
For some connections requiring a username and password, it may be necessary to use those credentials every time a message is sent to that system. In that type of flow, you might need to write something like:
    ```python
    import requests
    token = get_new_auth_token()
    patient = get_patient(token, patient_id)
    updated_patient_body = update_patient(patient, name="Frank")
    token = get_new_auth_token()
    update_patient(token, updated_patient_body)
    token = get_new_auth_token()
    schedule_appointment(token, patient=patient, type="telehealth")
    ...
    ```
Repeated, unnecessary calls to a token request function double the number of requests this script generates.
####  Do this 
Regardless of the authentication method used, a successful request includes `"expires_in": ` in the response body. The corresponding value will be an integer for the number of seconds until the token will be expired in Canvas. By reusing the token and eliminating redundant token requests, there is a **performance** gain from reducing the overall number of requests. The system is also more **secure** \- having fewer tokens reduces the overall surface area for illegitimate access
**General Guidelines:**
  - store the access token as securely as the client id and secret
  - depending on your use case, it may be best to store a token just for that session or to reuse it until it nears expiration
  - store the expiration datetime as well and check it before requesting a new token
  - use a refresh token if you provided in the authentication response for the authentication flow being used
There's any number of ways to do this in your language of choice. In Python, your code may look more like:
    ```python
    import os
    import requests
    from datetime import datetime, timedelta
    from urllib.parse import urlencode
    # we should get these from environment variables or a secure location at runtime, not in the code
    CLIENT_ID = os.getenv("CANVAS_API_CLIENT_ID")
    CLIENT_SECRET = os.getenv("CANVAS_API_CLIENT_SECRET")
    FUMAGE_BASE_URL = os.getenv("FUMAGE_BASE_URL")
    def get_new_auth_token():
        # Auth tokens are requested from the EMR instance, not the FHIR API.
        url = FUMAGE_BASE_URL.replace("fumage-", "")
        payload = urlencode(
            {
                "grant_type": "client_credentials",
                "client_id": f"{CLIENT_ID}",
                "client_secret": f"{CLIENT_SECRET}"
            }
        )
        headers = { "Content-Type": "application/x-www-form-urlencoded", }
        response = requests.post(f"{url}/auth/token/", headers=headers, data=payload)
        if response.status_code == 200:
            access_token = response.json()["access_token"]
            expiration_date = datetime.now() + timedelta(seconds=response.json()["expires_in"])
            os.environ["CANVAS_API_ACCESS_TOKEN"] = access_token
            os.environ["CANVAS_ACCESS_TOKEN_EXPIRATION_DATE"] = expiration_date.strftime("%m/%d/%y %H:%M:%S")
            return response.json()["access_token"]
        else:
            raise Exception(f"Could not acquire new auth token: {response.text}")
    if __name__ == '__main__':
        access_token = os.getenv("CANVAS_API_ACCESS_TOKEN")
        if expiration_date := os.getenv("CANVAS_ACCESS_TOKEN_EXPIRATION_DATE"):
            expiration_date = datetime.strptime(expiration_date, "%m/%d/%y %H:%M:%S")
        else:
            expiration_date = datetime.now()
         # only request a new token when we do not have a token or the one we have has expired
        if not access_token or expiration_date <= datetime.now():
            access_token = get_new_auth_token()
        headers = { "Authorization": f"Bearer {access_token}" }
        response = requests.get(f"{FUMAGE_BASE_URL}/Patient?name=Briddle", headers=headers)
        if response.status_code == 401:
            # attempt to acquire a new token 1 time if we get a 401 - maybe it was manually expired or
            # we have the wrong expiration date
            access_token = get_new_auth_token()
            headers = { "Authorization": f"Bearer {access_token}" }
            response = requests.get(f"{FUMAGE_BASE_URL}/Patient?name=Briddle", headers=headers)
            if response.status_code == 401:
                # limit retries but throw a specific exception for authentication related issues
                raise Exception(f"Cannot authenticate to Canvas after 1 retry: {response.text}")
            elif response.status_code != 200:
                # capture other issues as well
                raise Exception(f"{response.text}")
        patients = response.json()["entry"]
        for patient in patients:
            patient_id = patient["resource"]["id"]
            response = requests.get(f"{FUMAGE_BASE_URL}/Appointment?patient=Patient/{patient_id}", headers=headers)
            # do something with the appointments - save locally, modify and update, etc.
    ```
####  Takeaway 
  - **Safely stored access tokens can and should be reused!**  
  - Additional reading: 
    - [Token Best Practices from Auth0](https://auth0.com/docs/secure/tokens/token-best-practices)
----- END PAGE https://docs.canvasmedical.com/api/authentication-best-practices/


----- BEGIN PAGE https://docs.canvasmedical.com/api/careplan/
### 
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careplan.html>  
A CarePlan in Canvas translates to the [Integrated Care Plan PDF](https://canvas-medical.help.usepylon.com/articles/8547508751-administrative-menu-integrated-care-plan) you can print on the patient's chart. This endpoint will return either one or zero care plans for each patient. If no care plan was returned for a given patient, then that patient has never had a Goal command committed on their chart.
### Endpoints
get /CarePlan/{id} get /CarePlan
get
/CarePlan/{id}
#### CarePlan read
Read a CarePlan resource.
### Path Parameters
id required
string 
The unique identifier for the CarePlan   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the CarePlan.
text 
json 
Text summary of the resource, for human interpretation.
Click to view child attributes
status 
All resources returned from this endpoint will show a status of `generated` since this resource is generated by Canvas.
div 
Limited xhtml content that contains the human readable text of the resource.
status 
enum [active] 
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Currently, this value will always return `active`.
intent 
enum [plan] 
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. Currently, this value will always return `plan`.
category 
array[json] 
Type of plan.
Click to view child attributes
coding 
array[json] 
A CodeableConcept combination of one or more coding elements.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/CodeSystem/careplan-category 
  - http://snomed.info/sct 
code 
string 
The code of the category.
display 
string 
The display name of the coding.
subject 
json 
Who the care plan is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/CarePlan
#### CarePlan search
Search for CarePlan resources.
### Query Parameters
****
_id 
string 
The unique Canvas identifier of the CarePlan.
category 
string 
A category code in the format `system|code`.
**Search Values Supported:**
  - http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
  - http://snomed.info/sct|734163000
patient 
string 
The patient reference for who this care plan is for, in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
_revinclude 
string 
Standard FHIR `_revinclude` parameter.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the CarePlan.
text 
json 
Text summary of the resource, for human interpretation.
Click to view child attributes
status 
All resources returned from this endpoint will show a status of `generated` since this resource is generated by Canvas.
div 
Limited xhtml content that contains the human readable text of the resource.
status 
enum [active] 
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Currently, this value will always return `active`.
intent 
enum [plan] 
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. Currently, this value will always return `plan`.
category 
array[json] 
Type of plan.
Click to view child attributes
coding 
array[json] 
A CodeableConcept combination of one or more coding elements.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/CodeSystem/careplan-category 
  - http://snomed.info/sct 
code 
string 
The code of the category.
display 
string 
The display name of the coding.
subject 
json 
Who the care plan is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/CarePlan/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CarePlan/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "CarePlan",
            "id": "b4190e86-1a63-4010-85fe-5c42b607d2f9",
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">CarePlan</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Coding</td><td>{'system': 'http://snomed.info/sct', 'code': '734163000', 'display': 'Care plan'}</td></tr><tr><td>For Patient Name</td><td><span>Cube, Rubik N. (Nick Name)</span></td></tr></tbody></table></div>"
            },
            "status": "active",
            "intent": "plan",
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                            "code": "assess-plan"
                        }
                    ]
                },
                {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "734163000",
                            "display": "Care plan"
                        }
                    ]
                }
            ],
            "subject": {
                "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
                "type": "Patient"
            }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
            "resourceType": "OperationOutcome",
            "issue": [
                {
                    "severity": "error",
                    "code": "not-found",
                    "details": {
                        "text": "Unknown CarePlan resource '7d1ce256fcd7408193b0459650937a07'"
                    }
                }
            ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/CarePlan?patient=Patient/11430ad243f84ad2a47b1267d33ce9b8&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CarePlan?patient=Patient/11430ad243f84ad2a47b1267d33ce9b8&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/CarePlan?patient=Patient/a1197fa9e65b4a5195af15e0234f61c2&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/CarePlan?patient=Patient/a1197fa9e65b4a5195af15e0234f61c2&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/CarePlan?patient=Patient/a1197fa9e65b4a5195af15e0234f61c2&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "CarePlan",
                        "id": "b4190e86-1a63-4010-85fe-5c42b607d2f9",
                        "text": {
                            "status": "generated",
                            "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">CarePlan</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Coding</td><td>{'system': 'http://snomed.info/sct', 'code': '734163000', 'display': 'Care plan'}</td></tr><tr><td>For Patient Name</td><td><span>Cube, Rubik N. (Nick Name)</span></td></tr></tbody></table></div>"
                        },
                        "status": "active",
                        "intent": "plan",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                                        "code": "assess-plan"
                                    }
                                ]
                            },
                            {
                                "coding": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "734163000",
                                        "display": "Care plan"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
                            "type": "Patient"
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/careplan/


----- BEGIN PAGE https://docs.canvasmedical.com/api/careteam/
### 
The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html>  
All patients in Canvas have a CareTeam by default. The identifier for the CareTeam resource for a patient is the same as the patient identifier.   
See our [article](https://help.canvasmedical.com/articles/5628604712-manage-care-teams) for information about setting up Care Teams and Care Team Roles in Canvas.
### Endpoints
get /CareTeam/{id} put /CareTeam/{id} get /CareTeam
get
/CareTeam/{id}
#### CareTeam read
Read a CareTeam resource.
### Path Parameters
id required
string 
The unique identifier for the CareTeam   
The default behavior is to return all active care team participants for the patient. To return care team participants of a different status, add `.status` at the end of the ID (e.g `CareTeam/3e72c07b5aac4dc5929948f82c9afdfd.inactive`).
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the CareTeam.
status 
string 
The current state of the care team.
**Value Options Supported:**
  - proposed 
  - active 
  - suspended 
  - inactive 
  - entered-in-error 
name 
string 
Name of the team.   
This will always be set to `Care Team for <patient_last_name>, <patient_first_name>`
subject 
json 
Who care team is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
display 
string 
Display name of patient in the format `<patient_last_name>, <patient_first_name>`
participant 
array[json] 
Members of the team.  
Canvas allows either internal practitioners or external organizations to be members of a patient CareTeam. A practitioner can only have one role on a CareTeam, and only one practitioner can have a given role on a CareTeam. Organizations cannot be the lead of a CareTeam.   
Click to view child attributes
extension 
array[json] 
Canvas uses an extension to display whether a specific participant in a care team is the lead or not.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/careteam-lead 
valueBoolean 
boolean 
Value of extension. If the value is set to `True`, it indicates the specific participant as the lead for this care team. Only one active participant can be the lead of a care team. Only practitioners can be designated as the lead.
role 
array[json] 
Type of involvement. Required for Practitioner participants; not present (and ignored) for Organization participants.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.   
Needs to match a Care Team Role that is defined in the Settings of the Canvas instance.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the care team role.
display 
string 
The display name of the coding.
member 
json 
Who is involved.
Click to view child attributes
reference 
string 
The reference string of the member in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"` or `"Organization/8ab7cc3c-86f5-4723-ba26-7baf1f906ec7"`.
type 
string 
Type the reference refers to (e.g. "Practitioner", "Organization").
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/CareTeam/{id}
#### CareTeam update
Update a CareTeam resource.  
The CareTeam update endpoint acts as an upsert, so there is no CareTeam `create` endpoint. Any participants included in the payload will be the patient's active care team participants. While any participants no longer included in the payload will be marked as `inactive`.   
**If-Unmodified-Since Header** :  
Due to a legacy design detail with the CareTeam implementation, there is a specific condition under which inclusion of this header will not produce expected results. In the case where all participants of a CareTeam are removed through the Canvas user interface (i.e. not through the FHIR API), the last modified date for the CareTeam will be equal to the last modified date of the patient record until another participant is added to the CareTeam.  
More information about the If-Unmodified-Since header can be found in the [Conditional Requests documentation](/api/conditional-requests/).
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the CareTeam.
subject 
json 
Who care team is for.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
participant 
array[json] 
Members of the team.  
Canvas allows either internal practitioners or external organizations to be members of a patient CareTeam. A practitioner can only have one role on a CareTeam, and only one practitioner can have a given role on a CareTeam. Organizations cannot be the lead of a CareTeam.   
If `participant` is omitted or sent as an empty list, Canvas will inactivate any care team participants it finds for the given subject.
Click to view child attributes
extension 
array[json] 
Canvas supports the ability to mark a participant of a care team as the lead using a specific extension.   
If this extension is omitted, any current care team lead designated in Canvas will stay as the lead.
Click to view child attributes
url 
string required
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/careteam-lead 
valueBoolean 
boolean required
Value of extension. If the value is set to `True`, it indicates the specific participant as the lead for this care team. Only one active participant can be the lead of a care team. Only practitioners can be designated as the lead.
role 
array[json] required
Type of involvement. Required for Practitioner participants; not present (and ignored) for Organization participants.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.   
Needs to match a Care Team Role that is defined in the Settings of the Canvas instance.
Click to view child attributes
system 
string required
The system url of the coding.
code 
string required
The code of the care team role.
display 
string required
The display name of the coding.
member 
json required
Who is involved.
Click to view child attributes
reference 
string required
The reference string of the member in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"` or `"Organization/8ab7cc3c-86f5-4723-ba26-7baf1f906ec7"`.
type 
string 
Type the reference refers to (e.g. "Practitioner", "Organization").
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/CareTeam
#### CareTeam search
Search for CareTeam resources.
### Query Parameters
****
participant 
string 
Who is involved.   
Search to find all patient care teams that with a specific Practitioner or Organization member. Use the format `"Practitioner/ed1e304acdb847148338c6b0596d93fd"` or `"Organization/8ab7cc3c-86f5-4723-ba26-7baf1f906ec7"`
patient 
string 
Search for a specific patient's care team in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
status 
string 
Search for care team participants of a patient by a specific status. If a status is not specified to search by, note the `id` in the response batch will end in `.status` for all care teams that are not active statuses.
**Search Values Supported:**
  - proposed
  - active
  - suspended
  - inactive
  - entered-in-error
_revinclude 
string 
Standard FHIR `_revinclude` parameter.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the CareTeam.
status 
string 
The current state of the care team.
**Value Options Supported:**
  - proposed 
  - active 
  - suspended 
  - inactive 
  - entered-in-error 
name 
string 
Name of the team.   
This will always be set to `Care Team for <patient_last_name>, <patient_first_name>`
subject 
json 
Who care team is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
display 
string 
Display name of patient in the format `<patient_last_name>, <patient_first_name>`
participant 
array[json] 
Members of the team.  
Canvas allows either internal practitioners or external organizations to be members of a patient CareTeam. A practitioner can only have one role on a CareTeam, and only one practitioner can have a given role on a CareTeam. Organizations cannot be the lead of a CareTeam.   
Click to view child attributes
extension 
array[json] 
Canvas uses an extension to display whether a specific participant in a care team is the lead or not.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/careteam-lead 
valueBoolean 
boolean 
Value of extension. If the value is set to `True`, it indicates the specific participant as the lead for this care team. Only one active participant can be the lead of a care team. Only practitioners can be designated as the lead.
role 
array[json] 
Type of involvement. Required for Practitioner participants; not present (and ignored) for Organization participants.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.   
Needs to match a Care Team Role that is defined in the Settings of the Canvas instance.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the care team role.
display 
string 
The display name of the coding.
member 
json 
Who is involved.
Click to view child attributes
reference 
string 
The reference string of the member in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"` or `"Organization/8ab7cc3c-86f5-4723-ba26-7baf1f906ec7"`.
type 
string 
Type the reference refers to (e.g. "Practitioner", "Organization").
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/CareTeam/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CareTeam/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "CareTeam",
            "id": "8ab7cc3c86f54723ba267baf1f906ec7",
            "status": "active",
            "name": "Care Team for Amy V. Shaw",
            "subject": {
                "reference": "Patient/example",
                "type": "Patient",
                "display": "Amy V. Shaw"
            },
            "participant": [
                {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                            "valueBoolean": true
                        }
                    ],
                    "role": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "17561000",
                                    "display": "Cardiologist"
                                }
                            ]
                        }
                    ],
                    "member": {
                        "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab",
                        "display": "Ronald Bone, MD"
                    }
                },
                {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                            "valueBoolean": false
                        }
                    ],
                    "role": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "453231000124104",
                                    "display": "Primary care provider"
                                }
                            ]
                        }
                    ],
                    "member": {
                        "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e",
                        "display": "Kathy Fielding, MD"
                    }
                },
              {
                    "extension": [
                        {
                           "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                           "valueBoolean": false
                        }
                    ],
                    "member": {
                        "reference": "Organization/8ab7cc3c-86f5-4723-ba26-7baf1f906ec7",
                        "display": "Example Organization"
                    }
              }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown CareTeam resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/CareTeam/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "CareTeam",
            "id": "8ab7cc3c86f54723ba267baf1f906ec7",
            "status": "active",
            "name": "Care Team for Amy V. Shaw",
            "subject": {
                "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7",
                "type": "Patient",
                "display": "Amy V. Shaw"
            },
            "participant": [
                {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                            "valueBoolean": true
                        }
                    ],
                    "role": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "17561000",
                                    "display": "Cardiologist"
                                }
                            ]
                        }
                    ],
                    "member": {
                        "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab",
                        "display": "Ronald Bone, MD"
                    }
                },
                {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                            "valueBoolean": false
                        }
                    ],
                    "role": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "453231000124104",
                                    "display": "Primary care provider"
                                }
                            ]
                        }
                    ],
                    "member": {
                        "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e",
                        "display": "Kathy Fielding, MD"
                    }
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CareTeam/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "CareTeam",
            "id": "8ab7cc3c86f54723ba267baf1f906ec7",
            "status": "active",
            "name": "Care Team for Amy V. Shaw",
            "subject": {
                "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7",
                "type": "Patient",
                "display": "Amy V. Shaw"
            },
            "participant": [
                {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                            "valueBoolean": True
                        }
                    ],
                    "role": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "17561000",
                                    "display": "Cardiologist"
                                }
                            ]
                        }
                    ],
                    "member": {
                        "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab",
                        "display": "Ronald Bone, MD"
                    }
                },
                {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                            "valueBoolean": False
                        }
                    ],
                    "role": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "453231000124104",
                                    "display": "Primary care provider"
                                }
                            ]
                        }
                    ],
                    "member": {
                        "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e",
                        "display": "Kathy Fielding, MD"
                    }
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown CareTeam resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/CareTeam?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CareTeam?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/CareTeam?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/CareTeam?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/CareTeam?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "CareTeam",
                        "id": "8ab7cc3c86f54723ba267baf1f906ec7",
                        "status": "active",
                        "name": "Care Team for Amy V. Shaw",
                        "subject": {
                            "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7",
                            "type": "Patient",
                            "display": "Amy V. Shaw"
                        },
                        "participant": [
                            {
                                "extension": [
                                    {
                                        "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                                        "valueBoolean": true
                                    }
                                ],
                                "role": [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://snomed.info/sct",
                                                "code": "17561000",
                                                "display": "Cardiologist"
                                            }
                                        ]
                                    }
                                ],
                                "member": {
                                    "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab",
                                    "display": "Ronald Bone, MD"
                                }
                            },
                            {
                                "extension": [
                                    {
                                        "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                                        "valueBoolean": false
                                    }
                                ],
                                "role": [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://snomed.info/sct",
                                                "code": "453231000124104",
                                                "display": "Primary care provider"
                                            }
                                        ]
                                    }
                                ],
                                "member": {
                                    "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e",
                                    "display": "Kathy Fielding, MD"
                                }
                            },
                            {
                                  "extension": [
                                      {
                                         "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                                         "valueBoolean": false
                                      }
                                  ],
                                  "member": {
                                      "reference": "Organization/8ab7cc3c-86f5-4723-ba26-7baf1f906ec7",
                                      "display": "Example Organization"
                                  }
                            }
                        ]
                    }
                }, 
                {
                    "resource": {
                        "resourceType": "CareTeam",
                        "id": "8ab7cc3c86f54723ba267baf1f906ec7.inactive",
                        "status": "inactive",
                        "name": "Care Team for Amy V. Shaw",
                        "subject": {
                            "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7",
                            "type": "Patient",
                            "display": "Amy V. Shaw"
                        },
                        "participant": [
                            {
                                "extension": [
                                    {
                                        "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead",
                                        "valueBoolean": false
                                    }
                                ],
                                "role": [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://snomed.info/sct",
                                                "code": "17561000",
                                                "display": "Cardiologist"
                                            }
                                        ]
                                    }
                                ],
                                "member": {
                                    "reference": "Practitioner/390769eb976546ceaefe2507effcc665",
                                    "type": "Practitioner",
                                    "display": "Pat Byrnes"
                                }
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/careteam/


----- BEGIN PAGE https://docs.canvasmedical.com/api/ccda/
##  Software Requirements 
Software requirements for retrieving C-CDA via API calls can be found [here](/api/software-requirements)
##  Authentication 
If you have a Canvas Production instance, you will need to request a token and refresh it periodically. You can refer to our [Authentication Documentation](/api/customer-authentication) to get you set up.
##  Request and Parameters 
In order to generate a CCDA for a known patient key, you'll need to do a GET request to the endpoint `{YOUR_EHR_INSTANCE}/api/data-export/ccda/{patient_key}?document={document_type}`, where `document_type` can be either `continuity` or `referral`. You can check all parameters in the table below.
Parameter Name | Description | Requirement  
---|---|---  
document | Document type to be generated.  
Should be either `continuity` or `referral` | Mandatory  
start_date | Filter for the start date of the sections within the document.  
Format should be `YYYY-MM-DD` | Optional  
end_date | Filter for the end date of the sections within the document.  
Format should be `YYYY-MM-DD` | Optional  
generation_date | Overrides the generation date of the document.  
Format should be `YYYY-MM-DDTHH:mm:ss`, in UTC timezone | Optional  
##  Filtering 
`start_date` and `end_date` filter can be used to:
  - filter by a range of dates by inputing both parameters;
  - filter by a single date in the past by making `start_date` and `end_date` the same;
  - filter starting at a date in the past up until present time by only setting `start_date`;
  - filter from the beginning of time up to any date by only setting `end_date`;
##  Example and Response 
Here's a cURL example of a request for a continuity of care document, filtered for 2020-01-01 to 2020-12-31, and with a generation date of 2022-01-01, at 16:30 UTC:
    ```shell
    curl --request GET --header "Authorization: Bearer <token>" "<practice_subdomain>.canvasmedical.com/api/data-export/ccda/{PATIENT_KEY}?document=continuity&start_date=2024-01-01&end_date=2024-12-31&generation_date=2025-07-31T16:30:00"
    ```
A valid request will always return XML with the requested document as the response. If the `document` param is omitted, an empty XML will be returned.
##  Errors 
Canvas uses conventional HTTP response codes to indicate success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a request wasn't found, etc.). Codes in the 5xx range indicate an error with Canvas' server.
Error | Description  
---|---  
200 - OK | Everything worked as expected.  
403 - Forbidden | No valid Bearer token provided.  
404 - Not Found | The requested resource doesn't exist.  
500 - Server Error | Something went wrong on Canvas's end.
----- END PAGE https://docs.canvasmedical.com/api/ccda/


----- BEGIN PAGE https://docs.canvasmedical.com/api/claim-operations/
##  add-activity-log-item 
Add an activity log item to a Claim.  
This endpoint is a [FHIR operation](https://hl7.org/fhir/R4/operations.html), so it accepts a [Parameters](https://hl7.org/fhir/R4/parameters.html) resource in the request body. It will accept one and only one parameter, which must have the name **comment**. The comment that will be added is provided as a `valueString`. See the request example for more detail.
The bearer token included in requests send to this endpoint must have one of the following scopes:
  - `system/Claim.add-activity-log-item`
  - `user/Claim.add-activity-log-item`
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Claim/<id>/$add-activity-log-item' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Parameters",
            "parameter": [
                {
                    "name": "comment",
                    "valueString": "Test comment"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Claim/<id>/$add-activity-log-item"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Parameters",
            "parameter": [
                {
                    "name": "comment",
                    "valueString": "Test comment"
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
----- END PAGE https://docs.canvasmedical.com/api/claim-operations/


----- BEGIN PAGE https://docs.canvasmedical.com/api/claim/
### 
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.  
<http://hl7.org/fhir/R4/claim.html>
### Endpoints
post /Claim get /Claim/{id} put /Claim/{id} get /Claim
post
/Claim
#### Claim create
Create a Claim resource.
### Attributes
resourceType 
string 
The FHIR Resource name.
extension 
array[json] 
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues [here](https://canvas-medical.help.usepylon.com/articles/3240845520-queues).  
**Canvas Built-in Claim Queues**
display | code  
---|---  
Adjudicated | AdjudicatedOpenBalance  
Appointment | Appointment  
Clinician | NeedsClinicianReview  
Coding | NeedsCodingReview  
Filed | FiledAwaitingResponse  
History | ZeroBalance  
Patient | PatientBalance  
Rejected | RejectedNeedsReview  
Submission | QueuedForSubmission  
Trash | Trash  
It is possible to create custom queues in Canvas and utilize in the FHIR API.
By default, a claim is created in the **NeedsCodingReview** queue in Canvas.  
Sending a different value in this extension updates the claim to be in that queue.
Click to view child attributes
url 
string required
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/claim-queue 
valueCoding 
json required
Value of extension.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://canvasmedical.com 
code 
string required
**Value Options Supported:**
  - NeedsClinicianReview 
  - NeedsCodingReview 
  - QueuedForSubmission 
  - FiledAwaitingResponse 
  - RejectedNeedsReview 
  - AdjudicatedOpenBalance 
  - PatientBalance 
  - ZeroBalance 
  - Trash 
  - Appointment 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Adjudicated 
  - Appointment 
  - Clinician 
  - Coding 
  - Filed 
  - History 
  - Patient 
  - Rejected 
  - Submission 
  - Trash 
status 
enum [ active ] required
The status of the resource instance.
type 
json required
The category of claim.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/claim-type 
  - http://hl7.org/fhir/ValueSet/claim-type 
code 
string required
The code.
**Value Options Supported:**
  - professional 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Professional 
use 
enum [ claim ] required
A code to indicate the nature of the request.
patient 
json required
The Canvas patient resource for the claim.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ] required
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.  
This maps to the date of service for note in Canvas the claims is associated with.
provider 
json required
Party responsible for the claim. This will be a reference to a Practitioner.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Practitioner/bb24f084e1fa46c7931663259540266d"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
priority 
json required
The provider-required urgency of processing the request.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/process-priority 
  - http://terminology.hl7.org/CodeSystem/processpriority 
code 
string required
The code.
**Value Options Supported:**
  - normal 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Normal 
supportingInfo 
array[json] 
Additional information about the Claim.  
Canvas supports a single iteration for a reason for visit - the text in the `valueString` will be the note's RFV the claim is associated with.
Click to view child attributes
sequence 
positive integer required
Information instance identifier. Most likely will be `1` since Canvas currently only accepts one SupportingInfo object.
category 
json required
Classification of the supplied information.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/claim-informationcategory 
  - http://terminology.hl7.org/CodeSystem/claiminformationcategory 
code 
string required
The code.
**Value Options Supported:**
  - patientreasonforvisit 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Patient Reason for Visit 
valueString 
string 
Data to be provided.  
Canvas supports free text to be passed as the reason for visit associated with the claim.
diagnosis 
array[json] required
Information about diagnoses relevant to the claim items.
These diagnoses will create Assessments in Canvas. At least one diagnosis element is required.
Click to view child attributes
sequence 
positive integer required
Diagnosis instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisCodeableConcept 
json required
Nature of illness or problem.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/icd-10 
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string required
The ICD10 code. Canvas will automatically add the `.` when displaying in the UI (e.g the code 'H9190' is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
display 
string 
The display name of the coding.
insurance 
array[json] required
Patient insurance information. Contains the list of coverage's associated with the claim in Canvas.
If the claim should be a self paying claim, pass the insurance list as
    ```json
      "insurance": [
          {
              "sequence": 1,
              "focal": false,
              "coverage": {
                  "display": "No Coverage"
              }
          }
      ]
    ```
Click to view child attributes
focal 
boolean required
Coverage to be used for adjudication.
Canvas will ignore any elements that are set to False.
sequence 
positive integer required
Insurance instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
coverage 
json required
Insurance Information
Click to view child attributes
reference 
string 
The reference string of the coverage in the format of `"Coverage/05274c93-341c-4d23-9e46-718f6743609f"`.
display 
string 
A display of `"No Coverage"` are for claims that are self pay.
**Value Options Supported:**
  - No Coverage 
item 
array[json] required
List of service charges to be used in the claim.
Click to view child attributes
sequence 
positive integer required
Item instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisSequence 
array[positive integer] required
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the `Claim.diagnosis` list that this service charge is associated with.
productOrService 
json required
Billing, service, product, or drug code.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code 
  - http://www.ama-assn.org/go/cpt 
code 
string required
The code.
display 
string required
The display name of the coding.
quantity 
json required
Count of products or services.
Click to view child attributes
value 
integer 
Numerical value.
unitPrice 
json required
Fee, charge or cost per item.
Click to view child attributes
value 
integer 
Numerical value (with implicit precision)
modifier 
array[json] 
Product or service billing modifiers.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers 
  - https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets 
code 
string required
The code.
display 
string 
The display name of the coding.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Claim/{id}
#### Claim read
Read a Claim resource.
### Path Parameters
id required
string 
The unique identifier for the Claim   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Claim.
extension 
array[json] 
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues [here](https://canvas-medical.help.usepylon.com/articles/3240845520-queues).  
**Canvas Built-in Claim Queues**
display | code  
---|---  
Adjudicated | AdjudicatedOpenBalance  
Appointment | Appointment  
Clinician | NeedsClinicianReview  
Coding | NeedsCodingReview  
Filed | FiledAwaitingResponse  
History | ZeroBalance  
Patient | PatientBalance  
Rejected | RejectedNeedsReview  
Submission | QueuedForSubmission  
Trash | Trash  
It is possible to create custom queues in Canvas and utilize in the FHIR API.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note)   
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/claim-queue 
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueCoding 
json 
Value of extension.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://canvasmedical.com 
code 
string 
**Value Options Supported:**
  - NeedsClinicianReview 
  - NeedsCodingReview 
  - QueuedForSubmission 
  - FiledAwaitingResponse 
  - RejectedNeedsReview 
  - AdjudicatedOpenBalance 
  - PatientBalance 
  - ZeroBalance 
  - Trash 
  - Appointment 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Adjudicated 
  - Appointment 
  - Clinician 
  - Coding 
  - Filed 
  - History 
  - Patient 
  - Rejected 
  - Submission 
  - Trash 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
enum [ active ] 
The status of the resource instance.
type 
json 
The category of claim.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/claim-type 
  - http://hl7.org/fhir/ValueSet/claim-type 
code 
string 
The code.
**Value Options Supported:**
  - professional 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Professional 
use 
enum [ claim ] 
A code to indicate the nature of the request.
patient 
json 
The Canvas patient resource for the claim.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ] 
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.  
This maps to the date of service for note in Canvas the claims is associated with.
provider 
json 
Party responsible for the claim. This will be a reference to a Practitioner.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/bb24f084e1fa46c7931663259540266d"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
priority 
json 
The provider-required urgency of processing the request.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/process-priority 
  - http://terminology.hl7.org/CodeSystem/processpriority 
code 
string 
The code.
**Value Options Supported:**
  - normal 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Normal 
supportingInfo 
array[json] 
Additional information about the Claim.  
Canvas supports a single iteration for a reason for visit - the text in the `valueString` will be the note's RFV the claim is associated with.
Click to view child attributes
sequence 
positive integer 
Information instance identifier. Most likely will be `1` since Canvas currently only accepts one SupportingInfo object.
category 
json 
Classification of the supplied information.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/claim-informationcategory 
  - http://terminology.hl7.org/CodeSystem/claiminformationcategory 
code 
string 
The code.
**Value Options Supported:**
  - patientreasonforvisit 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Patient Reason for Visit 
valueString 
string 
Data to be provided.  
Canvas supports free text to be passed as the reason for visit associated with the claim.
diagnosis 
array[json] 
Information about diagnoses relevant to the claim items.
Click to view child attributes
sequence 
positive integer 
Diagnosis instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisCodeableConcept 
json 
Nature of illness or problem.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/icd-10 
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string 
The ICD10 code. Canvas will automatically add the `.` when displaying in the UI (e.g the code 'H9190' is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
display 
string 
The display name of the coding.
insurance 
array[json] 
Patient insurance information. Contains the list of coverage's associated with the claim in Canvas.
Click to view child attributes
focal 
boolean 
Coverage to be used for adjudication.
Only insurance objects with `focal` as True will be returned in a Search/Read.
sequence 
positive integer 
Insurance instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
coverage 
json 
Insurance Information
Click to view child attributes
reference 
string 
The reference string of the coverage in the format of `"Coverage/05274c93-341c-4d23-9e46-718f6743609f"`.
display 
string 
A display of `"No Coverage"` are for claims that are self pay.
**Value Options Supported:**
  - No Coverage 
item 
array[json] 
List of service charges to be used in the claim.
Click to view child attributes
sequence 
positive integer 
Item instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisSequence 
array[positive integer] 
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the `Claim.diagnosis` list that this service charge is associated with.
productOrService 
json 
Billing, service, product, or drug code.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code 
  - http://www.ama-assn.org/go/cpt 
code 
string 
The code.
display 
string 
The display name of the coding.
quantity 
json 
Count of products or services.
Click to view child attributes
value 
integer 
Numerical value.
unitPrice 
json 
Fee, charge or cost per item.
Click to view child attributes
value 
integer 
Numerical value (with implicit precision)
encounter 
array[json] 
Encounters related to this billed item.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
modifier 
array[json] 
Product or service billing modifiers.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers 
  - https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets 
code 
string 
The code.
display 
string 
The display name of the coding.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Claim/{id}
#### Claim update
Update a Claim resource.  
**The only Claim update supported by Canvas is to change an existing Claim's queue. Changes to other fields will be ignored, but required fields must still be valued.**
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the Claim.
extension 
array[json] 
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues [here](https://canvas-medical.help.usepylon.com/articles/3240845520-queues).  
**Canvas Built-in Claim Queues**
display | code  
---|---  
Adjudicated | AdjudicatedOpenBalance  
Appointment | Appointment  
Clinician | NeedsClinicianReview  
Coding | NeedsCodingReview  
Filed | FiledAwaitingResponse  
History | ZeroBalance  
Patient | PatientBalance  
Rejected | RejectedNeedsReview  
Submission | QueuedForSubmission  
Trash | Trash  
It is possible to create custom queues in Canvas and utilize in the FHIR API.
By default, a claim is created in the **NeedsCodingReview** queue in Canvas.  
Sending a different value in this extension updates the claim to be in that queue.
Click to view child attributes
url 
string required
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/claim-queue 
valueCoding 
json required
Value of extension.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://canvasmedical.com 
code 
string required
**Value Options Supported:**
  - NeedsClinicianReview 
  - NeedsCodingReview 
  - QueuedForSubmission 
  - FiledAwaitingResponse 
  - RejectedNeedsReview 
  - AdjudicatedOpenBalance 
  - PatientBalance 
  - ZeroBalance 
  - Trash 
  - Appointment 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Adjudicated 
  - Appointment 
  - Clinician 
  - Coding 
  - Filed 
  - History 
  - Patient 
  - Rejected 
  - Submission 
  - Trash 
status 
enum [ active ] required
The status of the resource instance.
type 
json required
The category of claim.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/claim-type 
  - http://hl7.org/fhir/ValueSet/claim-type 
code 
string required
The code.
**Value Options Supported:**
  - professional 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Professional 
use 
enum [ claim ] required
A code to indicate the nature of the request.
patient 
json required
The Canvas patient resource for the claim.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ] required
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.  
This maps to the date of service for note in Canvas the claims is associated with.
provider 
json required
Party responsible for the claim. This will be a reference to a Practitioner.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Practitioner/bb24f084e1fa46c7931663259540266d"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
priority 
json required
The provider-required urgency of processing the request.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/process-priority 
  - http://terminology.hl7.org/CodeSystem/processpriority 
code 
string required
The code.
**Value Options Supported:**
  - normal 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Normal 
supportingInfo 
array[json] 
Additional information about the Claim.  
Canvas supports a single iteration for a reason for visit - the text in the `valueString` will be the note's RFV the claim is associated with.
Click to view child attributes
sequence 
positive integer required
Information instance identifier. Most likely will be `1` since Canvas currently only accepts one SupportingInfo object.
category 
json required
Classification of the supplied information.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/claim-informationcategory 
  - http://terminology.hl7.org/CodeSystem/claiminformationcategory 
code 
string required
The code.
**Value Options Supported:**
  - patientreasonforvisit 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Patient Reason for Visit 
valueString 
string 
Data to be provided.  
Canvas supports free text to be passed as the reason for visit associated with the claim.
diagnosis 
array[json] 
Information about diagnoses relevant to the claim items.
These diagnoses will create Assessments in Canvas. At least one diagnosis element is required.
Click to view child attributes
sequence 
positive integer 
Diagnosis instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisCodeableConcept 
json 
Nature of illness or problem.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/icd-10 
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string 
The ICD10 code. Canvas will automatically add the `.` when displaying in the UI (e.g the code 'H9190' is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
display 
string 
The display name of the coding.
insurance 
array[json] required
Patient insurance information. Contains the list of coverage's associated with the claim in Canvas.
If the claim should be a self paying claim, pass the insurance list as
    ```json
      "insurance": [
          {
              "sequence": 1,
              "focal": false,
              "coverage": {
                  "display": "No Coverage"
              }
          }
      ]
    ```
Click to view child attributes
focal 
boolean required
Coverage to be used for adjudication.
Canvas will ignore any elements that are set to False.
sequence 
positive integer required
Insurance instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
coverage 
json required
Insurance Information
Click to view child attributes
reference 
string 
The reference string of the coverage in the format of `"Coverage/05274c93-341c-4d23-9e46-718f6743609f"`.
display 
string 
A display of `"No Coverage"` are for claims that are self pay.
**Value Options Supported:**
  - No Coverage 
item 
array[json] 
List of service charges to be used in the claim.
Click to view child attributes
sequence 
positive integer required
Item instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisSequence 
array[positive integer] 
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the `Claim.diagnosis` list that this service charge is associated with.
productOrService 
json required
Billing, service, product, or drug code.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code 
  - http://www.ama-assn.org/go/cpt 
code 
string required
The code.
display 
string required
The display name of the coding.
quantity 
json 
Count of products or services.
Click to view child attributes
value 
integer 
Numerical value.
unitPrice 
json 
Fee, charge or cost per item.
Click to view child attributes
value 
integer 
Numerical value (with implicit precision)
modifier 
array[json] 
Product or service billing modifiers.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers 
  - https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets 
code 
string required
The code.
display 
string 
The display name of the coding.
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Claim
#### Claim search
Search for Claim resources.
### Query Parameters
****
_id 
string 
The Canvas resource identifier of the Claim
patient 
string 
The patient reference associated to the Claim in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Claim.
extension 
array[json] 
Canvas supports a current queue extension representing the current queue the given claim is in on the Canvas instance. Learn more about navigating claim queues [here](https://canvas-medical.help.usepylon.com/articles/3240845520-queues).  
**Canvas Built-in Claim Queues**
display | code  
---|---  
Adjudicated | AdjudicatedOpenBalance  
Appointment | Appointment  
Clinician | NeedsClinicianReview  
Coding | NeedsCodingReview  
Filed | FiledAwaitingResponse  
History | ZeroBalance  
Patient | PatientBalance  
Rejected | RejectedNeedsReview  
Submission | QueuedForSubmission  
Trash | Trash  
It is possible to create custom queues in Canvas and utilize in the FHIR API.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note)   
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/claim-queue 
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueCoding 
json 
Value of extension.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://canvasmedical.com 
code 
string 
**Value Options Supported:**
  - NeedsClinicianReview 
  - NeedsCodingReview 
  - QueuedForSubmission 
  - FiledAwaitingResponse 
  - RejectedNeedsReview 
  - AdjudicatedOpenBalance 
  - PatientBalance 
  - ZeroBalance 
  - Trash 
  - Appointment 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Adjudicated 
  - Appointment 
  - Clinician 
  - Coding 
  - Filed 
  - History 
  - Patient 
  - Rejected 
  - Submission 
  - Trash 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
enum [ active ] 
The status of the resource instance.
type 
json 
The category of claim.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/claim-type 
  - http://hl7.org/fhir/ValueSet/claim-type 
code 
string 
The code.
**Value Options Supported:**
  - professional 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Professional 
use 
enum [ claim ] 
A code to indicate the nature of the request.
patient 
json 
The Canvas patient resource for the claim.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime [ YYYY-MM-DDTHH:mm:ssZZ | YYYY-MM-DD ] 
The date this resource was created. If only a date is specified, it will default to midnight UTC. If a timezone is not supplied, it will default to use UTC.  
This maps to the date of service for note in Canvas the claims is associated with.
provider 
json 
Party responsible for the claim. This will be a reference to a Practitioner.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/bb24f084e1fa46c7931663259540266d"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
priority 
json 
The provider-required urgency of processing the request.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/process-priority 
  - http://terminology.hl7.org/CodeSystem/processpriority 
code 
string 
The code.
**Value Options Supported:**
  - normal 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Normal 
supportingInfo 
array[json] 
Additional information about the Claim.  
Canvas supports a single iteration for a reason for visit - the text in the `valueString` will be the note's RFV the claim is associated with.
Click to view child attributes
sequence 
positive integer 
Information instance identifier. Most likely will be `1` since Canvas currently only accepts one SupportingInfo object.
category 
json 
Classification of the supplied information.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/claim-informationcategory 
  - http://terminology.hl7.org/CodeSystem/claiminformationcategory 
code 
string 
The code.
**Value Options Supported:**
  - patientreasonforvisit 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Patient Reason for Visit 
valueString 
string 
Data to be provided.  
Canvas supports free text to be passed as the reason for visit associated with the claim.
diagnosis 
array[json] 
Information about diagnoses relevant to the claim items.
Click to view child attributes
sequence 
positive integer 
Diagnosis instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisCodeableConcept 
json 
Nature of illness or problem.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/ValueSet/icd-10 
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string 
The ICD10 code. Canvas will automatically add the `.` when displaying in the UI (e.g the code 'H9190' is for the ICD10 H91.90 for unspecified hearing loss in an unspecified ear)
display 
string 
The display name of the coding.
insurance 
array[json] 
Patient insurance information. Contains the list of coverage's associated with the claim in Canvas.
Click to view child attributes
focal 
boolean 
Coverage to be used for adjudication.
Only insurance objects with `focal` as True will be returned in a Search/Read.
sequence 
positive integer 
Insurance instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
coverage 
json 
Insurance Information
Click to view child attributes
reference 
string 
The reference string of the coverage in the format of `"Coverage/05274c93-341c-4d23-9e46-718f6743609f"`.
display 
string 
A display of `"No Coverage"` are for claims that are self pay.
**Value Options Supported:**
  - No Coverage 
item 
array[json] 
List of service charges to be used in the claim.
Click to view child attributes
sequence 
positive integer 
Item instance identifier.  
The `sequence` should be unique within the Claim message, usually starting at 1 and incrementing as needed.
diagnosisSequence 
array[positive integer] 
Applicable diagnoses. This list of integers corresponds one or more diagnoses in the `Claim.diagnosis` list that this service charge is associated with.
productOrService 
json 
Billing, service, product, or drug code.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code 
  - http://www.ama-assn.org/go/cpt 
code 
string 
The code.
display 
string 
The display name of the coding.
quantity 
json 
Count of products or services.
Click to view child attributes
value 
integer 
Numerical value.
unitPrice 
json 
Fee, charge or cost per item.
Click to view child attributes
value 
integer 
Numerical value (with implicit precision)
encounter 
array[json] 
Encounters related to this billed item.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
modifier 
array[json] 
Product or service billing modifiers.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/us/carin-bb/ValueSet/AMACPTCMSHCPCSModifiers 
  - https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets 
code 
string 
The code.
display 
string 
The display name of the coding.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
            --url 'https://fumage-example.canvasmedical.com/Claim' \
            --header 'Authorization: Bearer <token>' \
            --header 'accept: application/json' \
            --header 'content-type: application/json' \
            --data '
        {
          "resourceType": "Claim",
          "extension": [
            {
              "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue",
              "valueCoding": {
                  "system": "http://canvasmedical.com",
                  "code": "NeedsClinicianReview",
                  "display": "Clinician"
              }
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/claim-type",
                "code": "professional"
              }
            ]
          },
          "use": "claim",
          "patient": {
            "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
            "type": "Patient"
          },
          "created": "2021-08-16",
          "provider": {
            "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
            "type": "Practitioner"
          },
          "priority": {
            "coding": [
              {
                "code": "normal",
                "system": "http://terminology.hl7.org/CodeSystem/processpriority"
              }
            ]
          },
          "supportingInfo": [
            {
              "sequence": 1,
              "category": {
                "coding": [
                  {
                    "code": "patientreasonforvisit",
                    "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory",
                    "display": "Patient Reason for Visit"
                  }
                ]
              },
              "valueString": "This is only...a test"
            }
          ],
          "diagnosis": [
            {
              "sequence": 1,
              "diagnosisCodeableConcept": {
                "coding": [
                  {
                    "code": "F41.1",
                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                    "display": "Generalized anxiety"
                  }
                ]
              }
            }
          ],
          "insurance": [
            {
              "sequence": 1,
              "focal": true,
              "coverage": {
                "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f"
              }
            }
          ],
          "item": [
            {
              "sequence": 1,
              "diagnosisSequence": [
                1
              ],
              "productOrService": {
                "coding": [
                  {
                    "system": "http://www.ama-assn.org/go/cpt",
                    "code": "exam",
                    "display": "Office visit"
                  }
                ]
              },
              "modifier": [
                {
                  "coding": [
                    {
                      "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets",
                      "code": "21"
                    }
                  ]
                }
              ],
              "quantity": {
                "value": 1
              },
              "unitPrice": {
                "value": 75
              }
            }
          ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Claim"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
          "resourceType": "Claim",
          "extension": [
            {
              "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue",
              "valueCoding": {
                  "system": "http://canvasmedical.com",
                  "code": "NeedsClinicianReview",
                  "display": "Clinician"
              }
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/claim-type",
                "code": "professional"
              }
            ]
          },
          "use": "claim",
          "patient": {
            "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
            "type": "Patient"
          },
          "created": "2021-08-16",
          "provider": {
            "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
            "type": "Practitioner"
          },
          "priority": {
            "coding": [
              {
                "code": "normal",
                "system": "http://terminology.hl7.org/CodeSystem/processpriority"
              }
            ]
          },
          "supportingInfo": [
            {
              "sequence": 1,
              "category": {
                "coding": [
                  {
                    "code": "patientreasonforvisit",
                    "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory",
                    "display": "Patient Reason for Visit"
                  }
                ]
              },
              "valueString": "This is only...a test"
            }
          ],
          "diagnosis": [
            {
              "sequence": 1,
              "diagnosisCodeableConcept": {
                "coding": [
                  {
                    "code": "F41.1",
                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                    "display": "Generalized anxiety"
                  }
                ]
              }
            }
          ],
          "insurance": [
            {
              "sequence": 1,
              "focal": True,
              "coverage": {
                "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f"
              }
            }
          ],
          "item": [
            {
              "sequence": 1,
              "diagnosisSequence": [
                1
              ],
              "productOrService": {
                "coding": [
                  {
                    "system": "http://www.ama-assn.org/go/cpt",
                    "code": "exam",
                    "display": "Office visit"
                  }
                ]
              },
              "modifier": [
                {
                  "coding": [
                    {
                      "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets",
                      "code": "21"
                    }
                  ]
                }
              ],
              "quantity": {
                "value": 1
              },
              "unitPrice": {
                "value": 75
              }
            }
          ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Claim/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Claim/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Claim",
            "id": "e4df0a15-d98c-400e-ad46-54eeb13f2753",
            "extension": [
              {
                "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue",
                "valueCoding": {
                    "system": "http://canvasmedical.com",
                    "code": "NeedsClinicianReview",
                    "display": "Clinician"
                }
              },
              {
                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                "valueId": "d4a09e6c-bcfb-4d7f-bcc6-aa6cc77eaff3"
              }
            ],
            "status": "active",
            "type": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/claim-type",
                        "code": "professional"
                    }
                ]
            },
            "use": "claim",
            "patient": {
                "reference": "Patient/4dc9d97b71924de58b54a9a91a8250dd",
                "type": "Patient"
            },
            "created": "2023-11-16",
            "provider": {
                "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                "type": "Practitioner"
            },
            "priority": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/processpriority",
                        "code": "normal"
                    }
                ]
            },
            "diagnosis": [
                {
                    "sequence": 1,
                    "diagnosisCodeableConcept": {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                "code": "J940",
                                "display": "Chylous effusion"
                            }
                        ]
                    }
                },
                {
                    "sequence": 2,
                    "diagnosisCodeableConcept": {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                "code": "L639",
                                "display": "Alopecia areata, unspecified"
                            }
                        ]
                    }
                }
            ],
            "insurance": [
                {
                    "sequence": 1,
                    "focal": true,
                    "coverage": {
                        "reference": "Coverage/39f37e33-bb0b-4e6b-88ca-56ea94629974",
                        "type": "Coverage"
                    }
                }
            ],
            "item": [
                {
                    "sequence": 1,
                    "diagnosisSequence": [
                        1,
                        2
                    ],
                    "productOrService": {
                        "coding": [
                            {
                                "system": "http://www.ama-assn.org/go/cpt",
                                "code": "99211",
                                "display": "Office outpatient visit 5 minutes"
                            }
                        ]
                    },
                    "quantity": {
                        "value": 1
                    },
                    "unitPrice": {
                        "value": 50.0
                    },
                    "net": {
                        "value": 50.0
                    }
                },
                {
                    "sequence": 2,
                    "diagnosisSequence": [
                        1
                    ],
                    "productOrService": {
                        "coding": [
                            {
                                "system": "http://www.ama-assn.org/go/cpt",
                                "code": "77012",
                                "display": "Ct guidance needle placement"
                            }
                        ]
                    },
                    "quantity": {
                        "value": 1
                    },
                    "unitPrice": {
                        "value": 200.0
                    },
                    "net": {
                        "value": 200.0
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Claim resource 'a47c7b0ebbb442cdbc4adf259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Claim/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
          "resourceType": "Claim",
          "extension": [
            {
              "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue",
              "valueCoding": {
                  "system": "http://canvasmedical.com",
                  "code": "AdjudicatedOpenBalance",
                  "display": "Adjudicated"
              }
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/claim-type",
                "code": "professional"
              }
            ]
          },
          "use": "claim",
          "patient": {
            "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
            "type": "Patient"
          },
          "created": "2021-08-16",
          "provider": {
            "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
            "type": "Practitioner"
          },
          "priority": {
            "coding": [
              {
                "code": "normal",
                "system": "http://terminology.hl7.org/CodeSystem/processpriority"
              }
            ]
          },
          "supportingInfo": [
            {
              "sequence": 1,
              "category": {
                "coding": [
                  {
                    "code": "patientreasonforvisit",
                    "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory",
                    "display": "Patient Reason for Visit"
                  }
                ]
              },
              "valueString": "This is only...a test"
            }
          ],
          "diagnosis": [
            {
              "sequence": 1,
              "diagnosisCodeableConcept": {
                "coding": [
                  {
                    "code": "F41.1",
                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                    "display": "Generalized anxiety"
                  }
                ]
              }
            }
          ],
          "insurance": [
            {
              "sequence": 1,
              "focal": true,
              "coverage": {
                "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f"
              }
            }
          ],
          "item": [
            {
              "sequence": 1,
              "diagnosisSequence": [
                1
              ],
              "productOrService": {
                "coding": [
                  {
                    "system": "http://www.ama-assn.org/go/cpt",
                    "code": "exam",
                    "display": "Office visit"
                  }
                ]
              },
              "modifier": [
                {
                  "coding": [
                    {
                      "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets",
                      "code": "21"
                    }
                  ]
                }
              ],
              "quantity": {
                "value": 1
              },
              "unitPrice": {
                "value": 75
              }
            }
          ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Claim/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
          "resourceType": "Claim",
          "extension": [
            {
              "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue",
              "valueCoding": {
                  "system": "http://canvasmedical.com",
                  "code": "AdjudicatedOpenBalance",
                  "display": "Adjudicated"
              }
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/claim-type",
                "code": "professional"
              }
            ]
          },
          "use": "claim",
          "patient": {
            "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
            "type": "Patient"
          },
          "created": "2021-08-16",
          "provider": {
            "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
            "type": "Practitioner"
          },
          "priority": {
            "coding": [
              {
                "code": "normal",
                "system": "http://terminology.hl7.org/CodeSystem/processpriority"
              }
            ]
          },
          "supportingInfo": [
            {
              "sequence": 1,
              "category": {
                "coding": [
                  {
                    "code": "patientreasonforvisit",
                    "system": "http://terminology.hl7.org/CodeSystem/claiminformationcategory",
                    "display": "Patient Reason for Visit"
                  }
                ]
              },
              "valueString": "This is only...a test"
            }
          ],
          "diagnosis": [
            {
              "sequence": 1,
              "diagnosisCodeableConcept": {
                "coding": [
                  {
                    "code": "F41.1",
                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                    "display": "Generalized anxiety"
                  }
                ]
              }
            }
          ],
          "insurance": [
            {
              "sequence": 1,
              "focal": True,
              "coverage": {
                "reference": "Coverage/02d4f77a-ebaf-47d5-b162-6313244aed5f"
              }
            }
          ],
          "item": [
            {
              "sequence": 1,
              "diagnosisSequence": [
                1
              ],
              "productOrService": {
                "coding": [
                  {
                    "system": "http://www.ama-assn.org/go/cpt",
                    "code": "exam",
                    "display": "Office visit"
                  }
                ]
              },
              "modifier": [
                {
                  "coding": [
                    {
                      "system": "https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets",
                      "code": "21"
                    }
                  ]
                }
              ],
              "quantity": {
                "value": 1
              },
              "unitPrice": {
                "value": 75
              }
            }
          ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Claim resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Claim?patient=Patient/4dc9d97b71924de58b54a9a91a8250dd' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Claim?patient=Patient/4dc9d97b71924de58b54a9a91a8250dd"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Claim?patient=4dc9d97b71924de58b54a9a91a8250dd&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Claim?patient=4dc9d97b71924de58b54a9a91a8250dd&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Claim?patient=4dc9d97b71924de58b54a9a91a8250dd&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Claim",
                        "id": "e4df0a15-d98c-400e-ad46-54eeb13f2753",
                        "extension": [
                          {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/claim-queue",
                            "valueCoding": {
                                "system": "http://canvasmedical.com",
                                "code": "AdjudicatedOpenBalance",
                                "display": "Adjudicated"
                            }
                          }
                        ],
                        "status": "active",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/claim-type",
                                    "code": "professional"
                                }
                            ]
                        },
                        "use": "claim",
                        "patient": {
                            "reference": "Patient/4dc9d97b71924de58b54a9a91a8250dd",
                            "type": "Patient"
                        },
                        "created": "2023-11-16",
                        "provider": {
                            "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                            "type": "Practitioner"
                        },
                        "priority": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/processpriority",
                                    "code": "normal"
                                }
                            ]
                        },
                        "diagnosis": [
                            {
                                "sequence": 1,
                                "diagnosisCodeableConcept": {
                                    "coding": [
                                        {
                                            "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                            "code": "J940",
                                            "display": "Chylous effusion"
                                        }
                                    ]
                                }
                            },
                            {
                                "sequence": 2,
                                "diagnosisCodeableConcept": {
                                    "coding": [
                                        {
                                            "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                            "code": "L639",
                                            "display": "Alopecia areata, unspecified"
                                        }
                                    ]
                                }
                            }
                        ],
                        "insurance": [
                            {
                                "sequence": 1,
                                "focal": true,
                                "coverage": {
                                    "reference": "Coverage/39f37e33-bb0b-4e6b-88ca-56ea94629974",
                                    "type": "Coverage"
                                }
                            }
                        ],
                        "item": [
                            {
                                "sequence": 1,
                                "diagnosisSequence": [
                                    1,
                                    2
                                ],
                                "productOrService": {
                                    "coding": [
                                        {
                                            "system": "http://www.ama-assn.org/go/cpt",
                                            "code": "99211",
                                            "display": "Office outpatient visit 5 minutes"
                                        }
                                    ]
                                },
                                "quantity": {
                                    "value": 1
                                },
                                "unitPrice": {
                                    "value": 50.0
                                },
                                "net": {
                                    "value": 50.0
                                }
                            },
                            {
                                "sequence": 2,
                                "diagnosisSequence": [
                                    1
                                ],
                                "productOrService": {
                                    "coding": [
                                        {
                                            "system": "http://www.ama-assn.org/go/cpt",
                                            "code": "77012",
                                            "display": "Ct guidance needle placement"
                                        }
                                    ]
                                },
                                "quantity": {
                                    "value": 1
                                },
                                "unitPrice": {
                                    "value": 200.0
                                },
                                "net": {
                                    "value": 200.0
                                }
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/claim/


----- BEGIN PAGE https://docs.canvasmedical.com/api/communication/
### 
An occurrence of information being transmitted; e.g. a message that was sent to a responsible provider  
<https://hl7.org/fhir/R4/communication.html>  
The Communication resource maps to messages in Canvas between a patient and practitioner. Click [here](https://canvas-medical.help.usepylon.com/articles/6255444430-patient-message-inbox) to learn more.  
**Additional HTML formatting**  
With the release of Advanced Letter Templates, Messages are now saved in the database in HTML format. Customers using the Communication endpoint for their own patient applications will need to take this into account either by embedding the html directly using a library like Interweave or extracting the text. **Messages sent before this update (10/26/2022 @ 17:00 PST) will remain in plain text format.**  
### Endpoints
post /Communication get /Communication/{id} get /Communication
post
/Communication
#### Communication create
Messages created through this endpoint will be added to the patient's timeline and in the patient app based on the ingestion date into Canvas.
### Attributes
resourceType 
string 
The FHIR Resource name.
status 
string required
The status of the transmission.
While status is a required attribute, all communication messages will be created with a `completed` status regardless of what is supplied in the payload.
**Value Options Supported:**
  - completed 
  - in-progress 
  - preparation 
  - unknown 
sent 
datetime 
When sent  
**ISO 8601 format**
If not supplied on creation, it will default to the current timestamp.
received 
datetime 
When received  
**ISO 8601 format**
If no `received` datetime is supplied when the recipient of the message is a Practitioner, the message will appear on the subject's timeline as unread, indicated by a blue circle on the message icon. The practitioner will have the ability to mark the communication message as read in the Canvas UI which will update this attribute.
recipient 
array[json] required
Message recipient.  
Supported reference types are a single **Patient** or **Practitioner**.
Between the sender and recipient, one must be a practitioner while the other must be a patient.
Click to view child attributes
reference 
string required
The reference string of the sender in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Patient" or "Practitioner").
sender 
json required
Message sender.  
Supported reference types are a single **Patient** or **Practitioner**.
Between the sender and recipient, one must be a practitioner while the other must be a patient.
Click to view child attributes
reference 
string required
The reference string of the sender in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Patient" or "Practitioner").
payload 
array[json] required
Message payload.  
Messages are now saved in the Canvas database in HTML format. Customers using the Communication endpoint for their own patient applications will need to take this into account either by embedding the html directly using a library like Interweave or extracting the text. Messages sent before 10/26/2022 @ 17:00 PST will remain in plain text format.
Click to view child attributes
contentString 
string required
Message part content.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Communication/{id}
#### Communication read
Read a Communication resource.
### Path Parameters
id required
string 
The unique identifier for the Communication   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the communication.
status 
string 
The status of the transmission.
A communication message in Canvas that was sent, received, delivered, or relayed will all appear in FHIR as `completed`. For draft messages in Canvas, they will appear in FHIR as `preparation`. While a FHIR status of `in-progress` are Canvas messages that are scheduled to be delivered at a later time.
**Value Options Supported:**
  - completed 
  - in-progress 
  - preparation 
  - unknown 
subject 
json 
Focus of the message. Always a **Patient** reference.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
sent 
datetime 
When sent  
**ISO 8601 format**
received 
datetime 
When received  
**ISO 8601 format**
Messages sent via Canvas UI to a patient will not have a `received` timestamp.   
If the received timestamp is not added via API to messages sent to practitioners, it can still be updated if the practitioner manually marks the message as read in the UI.
recipient 
array[json] 
Message recipient.  
Supported reference types are a single **Patient** or **Practitioner**.
Click to view child attributes
reference 
string 
The reference string of the sender in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Patient" or "Practitioner").
sender 
json 
Message sender.  
Supported reference types are a single **Patient** or **Practitioner**.
Click to view child attributes
reference 
string 
The reference string of the sender in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Patient" or "Practitioner").
payload 
array[json] 
Message payload.  
Messages are now saved in the Canvas database in HTML format. Customers using the Communication endpoint for their own patient applications will need to take this into account either by embedding the html directly using a library like Interweave or extracting the text. Messages sent before 10/26/2022 @ 17:00 PST will remain in plain text format.
Click to view child attributes
contentString 
string 
Message part content.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Communication
#### Communication search
Communication search will only return messages between a practitioner and patient, not between two practitioners.  
### Query Parameters
****
_id 
string 
The unique Canvas identifier of the Communication.
patient 
string 
The patient reference that is the subject of the communication in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
recipient 
string 
Message recipient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
sender 
string 
Message sender in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the communication.
status 
string 
The status of the transmission.
A communication message in Canvas that was sent, received, delivered, or relayed will all appear in FHIR as `completed`. For draft messages in Canvas, they will appear in FHIR as `preparation`. While a FHIR status of `in-progress` are Canvas messages that are scheduled to be delivered at a later time.
**Value Options Supported:**
  - completed 
  - in-progress 
  - preparation 
  - unknown 
subject 
json 
Focus of the message. Always a **Patient** reference.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
sent 
datetime 
When sent  
**ISO 8601 format**
received 
datetime 
When received  
**ISO 8601 format**
Messages sent via Canvas UI to a patient will not have a `received` timestamp.   
If the received timestamp is not added via API to messages sent to practitioners, it can still be updated if the practitioner manually marks the message as read in the UI.
recipient 
array[json] 
Message recipient.  
Supported reference types are a single **Patient** or **Practitioner**.
Click to view child attributes
reference 
string 
The reference string of the sender in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Patient" or "Practitioner").
sender 
json 
Message sender.  
Supported reference types are a single **Patient** or **Practitioner**.
Click to view child attributes
reference 
string 
The reference string of the sender in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Patient" or "Practitioner").
payload 
array[json] 
Message payload.  
Messages are now saved in the Canvas database in HTML format. Customers using the Communication endpoint for their own patient applications will need to take this into account either by embedding the html directly using a library like Interweave or extracting the text. Messages sent before 10/26/2022 @ 17:00 PST will remain in plain text format.
Click to view child attributes
contentString 
string 
Message part content.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Communication' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
          "resourceType": "Communication",
          "status": "unknown",
          "sent": "2022-04-29T13:30:00.000Z",
          "received": "2022-04-29T13:30:00.000Z",
          "recipient": [
            {
              "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd"
            }
          ],
          "sender": {
            "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14"
          },
          "payload": [
            {
              "contentString": "Upcoming appointment"
            }
          ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Communication"
        payload = {
            "resourceType": "Communication",
            "sent": "2022-04-29T13:30:00.000Z",
            "received": "2022-04-29T13:30:00.000Z",
            "recipient": [{ "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd" }],
            "sender": { "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14" },
            "payload": [{ "contentString": "Upcoming appointment" }]
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Communication?recipient=Patient/b3084f7e884e4af2b7e23b1dca494abd' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Communication?recipient=Patient/b3084f7e884e4af2b7e23b1dca494abd"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Bundle",
          "type": "searchset",
          "total": 1,
          "link": [
            {
              "relation": "self",
              "url": "/Communication?_id=7433b4b2-0d18-45ca-bb12-71105c80386b&_count=10&_offset=0"
            },
            {
              "relation": "first",
              "url": "/Communication?_id=7433b4b2-0d18-45ca-bb12-71105c80386b&_count=10&_offset=0"
            },
            {
              "relation": "last",
              "url": "/Communication?_id=7433b4b2-0d18-45ca-bb12-71105c80386b&_count=10&_offset=0"
            }
          ],
          "entry": [
            {
              "resource": {
                "resourceType": "Communication",
                "id": "7433b4b2-0d18-45ca-bb12-71105c80386b",
                "status": "completed",
                "sent": "2021-03-21T10:46:17+00:00",
                "received": "2022-03-14T12:03:58.958000+00:00",
                "subject": {
                  "reference": "Patient/4c21512185184e579b09bfac16dfdd2f",
                  "type": "Patient"
                },
                "recipient": [
                  {
                    "reference": "Patient/4c21512185184e579b09bfac16dfdd2f",
                    "type": "Patient"
                  }
                ],
                "sender": {
                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                    "type": "Practitioner"
                },
                "payload": [
                  {
                    "contentString": "Similique amet at est necessitatibus repellendus eius."
                  }
                ]
              }
            }
          ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "id": "101",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Communication/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Communication/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Communication",
            "id": "17b7d61e-4b0e-4940-bd37-b64f5c2ae29d",
            "status": "completed",
            "sent": "2023-10-23T21:19:22.865089+00:00",
            "received": "2023-10-23T21:21:00.000000+00:00",
            "subject": {
                "reference": "Patient/43f1418bae9c41919203e0006761067c",
                "type": "Patient"
            },
            "recipient": [
                {
                    "reference": "Practitioner/3640cd20de8a470aa570a852859ac87e",
                    "type": "Practitioner"
                }
            ],
            "sender": {
                "reference": "Patient/43f1418bae9c41919203e0006761067c",
                "type": "Patient"
            },
            "payload": [
                {
                    "contentString": "What's up doc?"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/communication/


----- BEGIN PAGE https://docs.canvasmedical.com/api/condition/
### 
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-encounter-diagnosis.html>  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html>
### Endpoints
post /Condition get /Condition/{id} put /Condition/{id} get /Condition
post
/Condition
#### Condition create
Create a Condition resource.  
This endpoint does not prevent duplicates in the record. **Canvas recommends performing a search prior to adding a new condition** to confirm whether the condition has already been created for the patient.  
If `clinicalStatus` is **active** , the Condition will be added as a `Diagnose` command. If it is not **active** , the Condition will be added as a `Past Medical History` command.  
If an `encounter` or a note ID in the `extension` is provided, the Condition will be added to the existing encounter (note). If it is not provided, a new data import note will be created.
### Attributes
resourceType 
string 
The FHIR Resource name.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note. If neither is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
clinicalStatus 
json required
The clinical status of the condition.
If clinicalStatus is active, the Condition will be added as a Diagnose command. If it is not active, the Condition will be added as a Past Medical History command.
Click to view child attributes
coding 
array[json] required
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-clinical 
code 
string required
The code of the clinical status.
**Value Options Supported:**
  - active 
  - resolved 
category 
array[json] required
A category assigned to the condition.
Click to view child attributes
coding 
array[json] required
Identifies where the definition of the code comes from.  
The codes `encounter-diagnosis` and `problem-list-item` are paired with the system `http://terminology.hl7.org/CodeSystem/condition-category`.  
The code `health-concern` is paired with the system `http://hl7.org/fhir/us/core/CodeSystem/condition-category`.  
The codes `sdoh`, `functional-status`, `disability-status`, and `cognitive-status` are paired with the system `http://hl7.org/fhir/us/core/CodeSystem/us-core-category`. Please note that these codings are only optionally included as a secondary codeable concept for problem list items or health concerns.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-category 
code 
string required
The category code.
**Value Options Supported:**
  - encounter-diagnosis 
  - problem-list-item 
  - health-concern 
  - sdoh 
  - functional-status 
  - disability-status 
  - cognitive-status 
code 
json required
Identification of the condition, problem or diagnosis.
Canvas will not validate the coding supplied in the payload, instead Canvas will just save the system, code, and display as provided. We highly recommend supplying a coding with the `system` of `http://hl7.org/fhir/sid/icd-10-cm`.
Click to view child attributes
coding 
array[json] required
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string required
The system url of the coding.
code 
string required
The code of the clinical status.
subject 
json required
Who has the condition.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter created as part of
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/f7663d7b-13bd-4236-843e-086306aea125"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
onsetDateTime 
date 
Estimated or actual date.
abatementDateTime 
date 
When in resolution/remission.
recordedDate 
datetime 
Date-time record was first recorded.
If ommitted it will default to the timestamp of ingestion into Canvas.
recorder 
json 
If ommitted, this will default to Canvas Bot.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
note 
array[json] 
Additional information about the Condition. This note only appears in the Canvas UI for resolved conditions.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Condition/{id}
#### Condition read
Read a Condition resource.
### Path Parameters
id required
string 
The unique identifier for the Condition   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Condition.
text 
json 
Text summary of the Condition, for human interpretation.
Click to view child attributes
status 
enum [ generated ] 
The status of the narrative.
div 
string 
Limited xhtml content that contains the human readable text of the Condition.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
clinicalStatus 
json 
The clinical status of the condition.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-clinical 
code 
string 
The code of the clinical status.
**Value Options Supported:**
  - active 
  - resolved 
  - relapse 
  - remission 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Active 
  - Resolved 
  - Relapse 
  - Remission 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Active 
  - Resolved 
  - Relapse 
  - Remission 
verificationStatus 
json 
The verification status to support the clinical status of the condition.
A `confirmed` status corresponds to committed conditions from a Diagnose or Past Medical History command. An `entered-in-error` status means the Diagnose or Past Medical History command was entered-in-error. A `provisional` condition means it was added as an `indication` to either Image, Refer, POC Lab Test, or a Lab Order command.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-ver-status 
code 
string 
The code of the clinical status.
**Value Options Supported:**
  - confirmed 
  - entered-in-error 
  - provisional 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
  - Provisional 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
  - Provisional 
category 
array[json] 
A category assigned to the condition.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.  
The codes `encounter-diagnosis` and `problem-list-item` are paired with the system `http://terminology.hl7.org/CodeSystem/condition-category`.  
The code `health-concern` is paired with the system `http://hl7.org/fhir/us/core/CodeSystem/condition-category`.  
The codes `sdoh`, `functional-status`, `disability-status`, and `cognitive-status` are paired with the system `http://hl7.org/fhir/us/core/CodeSystem/us-core-category`. Please note that these codings are only optionally included as a secondary codeable concept for problem list items or health concerns.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-category 
code 
string 
The category code.
**Value Options Supported:**
  - encounter-diagnosis 
  - problem-list-item 
  - health-concern 
  - sdoh 
  - functional-status 
  - disability-status 
  - cognitive-status 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Encounter Diagnosis 
  - Problem List Item 
  - Health Concern 
  - SDOH 
  - Functional Status 
  - Disability Status 
  - Cognitive Status 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Encounter Diagnosis 
  - Problem List Item 
  - Health Concern 
  - SDOH 
  - Functional Status 
  - Disability Status 
  - Cognitive Status 
code 
json 
Identification of the condition, problem or diagnosis.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the clinical status.
display 
string 
The display name of the coding.
subject 
json 
Who has the condition.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter created as part of
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/f7663d7b-13bd-4236-843e-086306aea125"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
onsetDateTime 
date 
Estimated or actual date.
abatementDateTime 
date 
When in resolution/remission.
recordedDate 
datetime 
Date-time record was first recorded.
recorder 
json 
Who recorded the condition.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
note 
array[json] 
Additional information about the Condition. This note only appears in the Canvas UI for resolved conditions.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Condition/{id}
#### Condition update
Update a Condition resource.  
The only type of Condition update interaction that is supported by Canvas is to mark an existing Condition as **entered-in-error**. No changes to other fields will be processed. All required fields must still be provided, but out FHIR Update will assume a call to the FHIR Condition Update is an intention to mark the condition as entered-in-error.
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the Condition.
clinicalStatus 
json required
The clinical status of the condition.
Click to view child attributes
coding 
array[json] required
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-clinical 
code 
string required
The code of the clinical status.
**Value Options Supported:**
  - active 
  - resolved 
category 
array[json] required
A category assigned to the condition.
Click to view child attributes
coding 
array[json] required
Identifies where the definition of the code comes from.  
The codes `encounter-diagnosis` and `problem-list-item` are paired with the system `http://terminology.hl7.org/CodeSystem/condition-category`.  
The code `health-concern` is paired with the system `http://hl7.org/fhir/us/core/CodeSystem/condition-category`.  
The codes `sdoh`, `functional-status`, `disability-status`, and `cognitive-status` are paired with the system `http://hl7.org/fhir/us/core/CodeSystem/us-core-category`. Please note that these codings are only optionally included as a secondary codeable concept for problem list items or health concerns.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-category 
code 
string required
The category code.
**Value Options Supported:**
  - encounter-diagnosis 
  - problem-list-item 
  - health-concern 
  - sdoh 
  - functional-status 
  - disability-status 
  - cognitive-status 
code 
json required
Identification of the condition, problem or diagnosis.
Click to view child attributes
coding 
array[json] required
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string required
The system url of the coding.
code 
string required
The code of the clinical status.
subject 
json required
Who has the condition.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
recorder 
json 
On an Update this Practitioner will become the user in Canvas who marked the Condition as entered-in-error. If ommitted, it will default to Canvas Bot.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Condition
#### Condition search
Search for Condition resources.
### Query Parameters
****
_id 
string 
The identifier of the Condition.
clinical-status 
string 
The clinical status of the condition.
**Search Values Supported:**
  - active
  - resolved
patient 
string 
The patient reference associated to the Condition in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
verification-status 
string 
The verification status to support the clinical status of the condition.
**Search Values Supported:**
  - confirmed
  - entered-in-error
  - provisional
category 
string 
The category of the condition. Filters by the code and/or system under `category.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g. `http://terminology.hl7.org/CodeSystem/condition-category|health-concern`).
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Condition.
text 
json 
Text summary of the Condition, for human interpretation.
Click to view child attributes
status 
enum [ generated ] 
The status of the narrative.
div 
string 
Limited xhtml content that contains the human readable text of the Condition.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
clinicalStatus 
json 
The clinical status of the condition.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-clinical 
code 
string 
The code of the clinical status.
**Value Options Supported:**
  - active 
  - resolved 
  - relapse 
  - remission 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Active 
  - Resolved 
  - Relapse 
  - Remission 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Active 
  - Resolved 
  - Relapse 
  - Remission 
verificationStatus 
json 
The verification status to support the clinical status of the condition.
A `confirmed` status corresponds to committed conditions from a Diagnose or Past Medical History command. An `entered-in-error` status means the Diagnose or Past Medical History command was entered-in-error. A `provisional` condition means it was added as an `indication` to either Image, Refer, POC Lab Test, or a Lab Order command.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-ver-status 
code 
string 
The code of the clinical status.
**Value Options Supported:**
  - confirmed 
  - entered-in-error 
  - provisional 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
  - Provisional 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Confirmed 
  - Entered in Error 
  - Provisional 
category 
array[json] 
A category assigned to the condition.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.  
The codes `encounter-diagnosis` and `problem-list-item` are paired with the system `http://terminology.hl7.org/CodeSystem/condition-category`.  
The code `health-concern` is paired with the system `http://hl7.org/fhir/us/core/CodeSystem/condition-category`.  
The codes `sdoh`, `functional-status`, `disability-status`, and `cognitive-status` are paired with the system `http://hl7.org/fhir/us/core/CodeSystem/us-core-category`. Please note that these codings are only optionally included as a secondary codeable concept for problem list items or health concerns.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/condition-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-category 
code 
string 
The category code.
**Value Options Supported:**
  - encounter-diagnosis 
  - problem-list-item 
  - health-concern 
  - sdoh 
  - functional-status 
  - disability-status 
  - cognitive-status 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Encounter Diagnosis 
  - Problem List Item 
  - Health Concern 
  - SDOH 
  - Functional Status 
  - Disability Status 
  - Cognitive Status 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Encounter Diagnosis 
  - Problem List Item 
  - Health Concern 
  - SDOH 
  - Functional Status 
  - Disability Status 
  - Cognitive Status 
code 
json 
Identification of the condition, problem or diagnosis.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the clinical status.
display 
string 
The display name of the coding.
subject 
json 
Who has the condition.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter created as part of
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/f7663d7b-13bd-4236-843e-086306aea125"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
onsetDateTime 
date 
Estimated or actual date.
abatementDateTime 
date 
When in resolution/remission.
recordedDate 
datetime 
Date-time record was first recorded.
recorder 
json 
Who recorded the condition.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
note 
array[json] 
Additional information about the Condition. This note only appears in the Canvas UI for resolved conditions.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Condition' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Condition",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                        "code": "resolved",
                        "display": "Resolved"
                    }
                ],
                "text": "Resolved"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                        "code": "confirmed",
                        "display": "Confirmed"
                    }
                ],
                "text": "Confirmed"
            },
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                            "code": "problem-list-item",
                            "display": "Problem List Item"
                        }
                    ],
                    "text": "Problem List Item"
                }
            ],
            "code": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/sid/icd-10-cm",
                        "code": "V97.21XS",
                        "display": "Parachutist entangled in object, sequela"
                    }
                ],
                "text": "Parachutist entangled in object, sequela"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "abatementDateTime": "2023-06-17",
            "recordedDate": "2023-06-18T15:00:00-04:00",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "note": [
                {
                    "text": "Condition note"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Condition"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Condition",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                        "code": "resolved",
                        "display": "Resolved"
                    }
                ],
                "text": "Resolved"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                        "code": "confirmed",
                        "display": "Confirmed"
                    }
                ],
                "text": "Confirmed"
            },
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                            "code": "problem-list-item",
                            "display": "Problem List Item"
                        }
                    ],
                    "text": "Problem List Item"
                }
            ],
            "code": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/sid/icd-10-cm",
                        "code": "V97.21XS",
                        "display": "Parachutist entangled in object, sequela"
                    }
                ],
                "text": "Parachutist entangled in object, sequela"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "abatementDateTime": "2023-06-17",
            "recordedDate": "2023-06-18T15:00:00-04:00",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "note": [
                {
                    "text": "Condition note"
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Condition/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Condition/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Condition",
            "id": "3340c331-d446-4700-9c23-7959bd393f26",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus":
            {
                "coding":
                [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                        "code": "resolved",
                        "display": "Resolved"
                    }
                ],
                "text": "Resolved"
            },
            "verificationStatus":
            {
                "coding":
                [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                        "code": "confirmed",
                        "display": "Confirmed"
                    }
                ],
                "text": "Confirmed"
            },
            "category":
            [
                {
                    "coding":
                    [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                            "code": "problem-list-item",
                            "display": "Problem List Item"
                        }
                    ],
                    "text": "Problem List Item"
                }
            ],
            "code":
            {
                "coding":
                [
                    {
                        "system": "http://hl7.org/fhir/sid/icd-10-cm",
                        "code": "V97.21XS",
                        "display": "Parachutist entangled in object, sequela"
                    }
                ],
                "text": "Parachutist entangled in object, sequela"
            },
            "subject":
            {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter":
            {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "abatementDateTime": "2023-06-17",
            "recordedDate": "2023-06-18T15:00:00-04:00",
            "recorder":
            {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "note":
            [
                {
                    "text": "Condition note"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Condition resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Condition/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Condition",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                        "code": "resolved",
                        "display": "Resolved"
                    }
                ],
                "text": "Resolved"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                        "code": "entered-in-error",
                        "display": "Entered in Error"
                    }
                ],
                "text": "Entered in Error"
            },
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                            "code": "problem-list-item",
                            "display": "Problem List Item"
                        }
                    ],
                    "text": "Problem List Item"
                }
            ],
            "code": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/sid/icd-10-cm",
                        "code": "V97.21XS",
                        "display": "Parachutist entangled in object, sequela"
                    }
                ],
                "text": "Parachutist entangled in object, sequela"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "abatementDateTime": "2023-06-17",
            "recordedDate": "2023-06-18T15:00:00-04:00",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "note": [
                {
                    "text": "Condition note"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Condition/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Condition",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "clinicalStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                        "code": "resolved",
                        "display": "Resolved"
                    }
                ],
                "text": "Resolved"
            },
            "verificationStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                        "code": "entered-in-error",
                        "display": "Entered in Error"
                    }
                ],
                "text": "Entered in Error"
            },
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                            "code": "problem-list-item",
                            "display": "Problem List Item"
                        }
                    ],
                    "text": "Problem List Item"
                }
            ],
            "code": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/sid/icd-10-cm",
                        "code": "V97.21XS",
                        "display": "Parachutist entangled in object, sequela"
                    }
                ],
                "text": "Parachutist entangled in object, sequela"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "onsetDateTime": "2023-06-15",
            "abatementDateTime": "2023-06-17",
            "recordedDate": "2023-06-18T15:00:00-04:00",
            "recorder": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "note": [
                {
                    "text": "Condition note"
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Condition resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Condition?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&category=http://terminology.hl7.org/CodeSystem/condition-category|health-concern' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Condition?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&category=http://terminology.hl7.org/CodeSystem/condition-category|health-concern"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Condition?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Condition?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Condition?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Condition",
                        "id": "3340c331-d446-4700-9c23-7959bd393f26",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                                "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                            }
                        ],
                        "clinicalStatus": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                                    "code": "resolved",
                                    "display": "Resolved"
                                }
                            ],
                            "text": "Resolved"
                        },
                        "verificationStatus": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                                    "code": "confirmed",
                                    "display": "Confirmed"
                                }
                            ],
                            "text": "Confirmed"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                                        "code": "problem-list-item",
                                        "display": "Problem List Item"
                                    }
                                ],
                                "text": "Problem List Item"
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                    "code": "V97.21XS",
                                    "display": "Parachutist entangled in object, sequela"
                                }
                            ],
                            "text": "Parachutist entangled in object, sequela"
                        },
                        "subject": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
                        },
                        "encounter": {
                            "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
                        },
                        "onsetDateTime": "2023-06-15",
                        "abatementDateTime": "2023-06-17",
                        "recordedDate": "2023-06-18T15:00:00-04:00",
                        "recorder": {
                            "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
                        },
                        "note": [
                            {
                                "text": "Condition note"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/condition/


----- BEGIN PAGE https://docs.canvasmedical.com/api/conditional-requests/
##  If-Unmodified-Since 
Endpoints that perform update operations support the conditional header [If-Unmodified-Since](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Unmodified-Since).
If a request includes this header, then updates will be rejected if the stored resource has been modified since the date specified in the header, and a 412 Precondition Failed response will be returned.
The date should be in the format specified by [RFC 2616](https://www.rfc-editor.org/rfc/rfc2616).
    ```plaintext
    If-Unmodified-Since: Wed, 21 Oct 2015 07:28:00 GMT
    ```
----- END PAGE https://docs.canvasmedical.com/api/conditional-requests/


----- BEGIN PAGE https://docs.canvasmedical.com/api/consent/
### 
A record of a healthcare consumer's choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.  
<https://hl7.org/fhir/R4/consent.html>   
For more information on consents in canvas, see this [article](https://help.canvasmedical.com/articles/8144965836-manging-patient-consents).
### Endpoints
post /Consent get /Consent/{id} get /Consent
post
/Consent
#### Consent create
Before creating a consent via the API, Patient Consent Codings **must** be [configured in Canvas](https://canvas-medical.help.usepylon.com/articles/8727821967-patient-consents).  
**Updating existing patient consent objects**  
A patient consent is uniquely distinguished by its patient and consent coding  
This Create endpoint also acts as an Update endpoint. If the patient already has an existing patient consent with the same consent coding, the endpoint updates that consent in place and the id returned in the response will not be changed.
### Attributes
resourceType 
string 
The FHIR Resource name.
status 
string required
Indicates the current state of this consent.
**Value Options Supported:**
  - active 
  - rejected 
scope 
json required
For create interactions, this field is required by FHIR but ignored by Canvas, so {} is an accepted value.
Click to view child attributes
text 
string 
Plain text representation of the concept
**Value Options Supported:**
  - Unknown 
category 
array[json] required
A `system/code` or a `system/display` is required to be able to identify the consent category being created/updated.
Click to view child attributes
coding 
array[json] required
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string required
The system url of the coding.
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
patient 
json required
Who the consent applies to
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
sourceAttachment 
json required
The source on which this consent statement is based.
The source on which this consent is based.  
For create interactions, `sourceAttachment.title`, `sourceAttachment.contentType`, and `sourceAttachment.data` are required.
Click to view child attributes
title 
string required
Label to display in place of the data.
contentType 
string required
Mime type of the content, with charset etc.
**Value Options Supported:**
  - application/pdf 
data 
string required
Data inline, base64ed.
provision 
json required
Constraints to the base Consent.  
Canvas uses `period.start` and `period.end` to define the start and end dates of the consent.
For create interactions, `period.start` is required with a **YYYY-MM-DD** format.  
A `period.end` with a past date will mark the consent as Expired in the UI.
Click to view child attributes
period 
json required
Timeframe for this rule
Click to view child attributes
start 
date required
Starting time with inclusive boundary
end 
date 
End time with inclusive boundary, if not ongoing.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Consent/{id}
#### Consent read
Read a Consent resource
### Path Parameters
id required
string 
The unique identifier for the Consent   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Consent.
status 
string 
Indicates the current state of this consent. Read interactions may also return `inactive` for consents whose `period.end` has passed.
**Value Options Supported:**
  - active 
  - rejected 
  - inactive 
scope 
json 
Type of consent being presented (e.g. ADR, Privacy, Treatment, Research).
Click to view child attributes
text 
string 
Plain text representation of the concept
**Value Options Supported:**
  - Unknown 
category 
array[json] 
A classification of the type of consents found in the statement.  
The category.coding needs to match a patient consent coding record defined in the Canvas Admin Settings page.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
patient 
json 
Who the consent applies to
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
dateTime 
datetime 
When this Consent was issued / created / indexed.  
This value will be the Consent's datetime of ingestion in Canvas.
sourceAttachment 
json 
The source on which this consent statement is based.
Canvas returns the `sourceAttachment.url` for the document associated with the consent that has the latest period.start date.
Click to view child attributes
url 
url 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
provision 
json 
Constraints to the base Consent.  
Canvas uses `period.start` and `period.end` to define the start and end dates of the consent.
Click to view child attributes
period 
json 
Timeframe for this rule
Click to view child attributes
start 
date 
Starting time with inclusive boundary
end 
date 
End time with inclusive boundary, if not ongoing.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Consent
#### Consent search
Search for Consent resources
### Query Parameters
****
_id 
string 
The Canvas-issued unique identifier of the Consent.
patient 
string 
Who the consent applies to in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`
period 
date 
Search by the period.start. See [Date Filtering](/api/date-filtering) for more information.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Consent.
status 
string 
Indicates the current state of this consent. Read interactions may also return `inactive` for consents whose `period.end` has passed.
**Value Options Supported:**
  - active 
  - rejected 
  - inactive 
scope 
json 
Type of consent being presented (e.g. ADR, Privacy, Treatment, Research).
Click to view child attributes
text 
string 
Plain text representation of the concept
**Value Options Supported:**
  - Unknown 
category 
array[json] 
A classification of the type of consents found in the statement.  
The category.coding needs to match a patient consent coding record defined in the Canvas Admin Settings page.
Click to view child attributes
coding 
array[json] 
Identifies where the definition of the code comes from.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
patient 
json 
Who the consent applies to
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
dateTime 
datetime 
When this Consent was issued / created / indexed.  
This value will be the Consent's datetime of ingestion in Canvas.
sourceAttachment 
json 
The source on which this consent statement is based.
Canvas returns the `sourceAttachment.url` for the document associated with the consent that has the latest period.start date.
Click to view child attributes
url 
url 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
provision 
json 
Constraints to the base Consent.  
Canvas uses `period.start` and `period.end` to define the start and end dates of the consent.
Click to view child attributes
period 
json 
Timeframe for this rule
Click to view child attributes
start 
date 
Starting time with inclusive boundary
end 
date 
End time with inclusive boundary, if not ongoing.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```sh
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Consent' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
          "resourceType": "Consent",
          "status": "active",
          "scope": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/consentscope",
                "code": "patient-privacy"
              }
            ]
          },
          "category": [
            {
              "coding": [
                {
                  "system": "ConsentCoding_System_ConfigureInAdmin",
                  "code": "ConsentCoding_Code_ConfigureInAdmin",
                  "display": "ConsentCoding_Display_ConfigureInAdmin"
                }
              ]
            }
          ],
          "patient": {
            "reference": "Patient/5350cd20de8a470aa570a852859ac87e"
          },
          "sourceAttachment": {
            "contentType": "application/pdf",
            "data": "JVBERi0xLjYKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCXKuwqEQAxG4T5P8dcLxiS6MyMMUwha2AkBi8VuL52gja+/gpzia46w4qQdAmGxhKDKXVTE7vb40PLAdh9Xx496p2fghGgtB/gb9ahQg39fWbSElMWKZmlKZVnasvpEg9NMM/7+cxdrCmVuZHN0cmVhbQplbmRvYmoKCjMgMCBvYmoKMTA2CmVuZG9iagoKNSAwIG9iago8PC9MZW5ndGggNiAwIFIvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aDEgODE4ND4+CnN0cmVhbQp4nOU5fXATV36/tyvZ8geW7NjCILCe2NhgbEv+AMKXsbAt2cYGy19EMgRrLa0tBVtSJdkEcpn42iZhRCgcuSYlYSbpTC+T3KTDOk5b5yYNzl3T9nq9S9I0c5NLaJi5u2lnCgPNJWnncuD+3tuVMYSQaaf/deW3+/v+fk9aSCenFCiEGRDBHZqUE6VGgwAA/whASkLTadrcW7YD4UsAwj+NJcYnn/2rg58BGF4DyH1tfOLo2Or+l9MAhREA8d2IIodPNW6rAbBsRRtbIkjovnE0F/EE4vdGJtMPXSSLJYh/F/HSiXhIpuIoQfwlxAsn5YcSDsN29G9B+0Bj8qTyX+d+FEb8nwEKUol4Cn2JyFrTyfiJpJLoeXb0bcSZ/9NII/hhVyGCOQwXRAP8f76MJ6EMOo3NYIYEv99yia/AKjgLsHiZYTfvN3oWf/t/GYVJe/wJvAivwUn4EB7QGV7wQRSmkLL8egveQyq7fDAM34fM15h9BeaRr8kF4RTL5I6XD56BOfi7W7z4YBIexlj+Aj4kDfBjHJU4fEpM8G14G61+irS9dzIlFOFtjINjy6gfwXPCCdgj/AqRs4wjuAQL/A2cI4fQchrzPLmU8c6vGH0CHsH7AERgGmF+GZt/9wvIW/wNZvUI7IHfh90wsUzjDfK8mI/9G4TnsaZvcZory8ztFB8U/lIQrj+FyHdgHJdMMHfhpLj7ayr0P77EIVhBqsVKyLsTV9gE5hu/FRoXPxPvhXwYWryWpS12L/5GlG/EDCOGNcZmw0/u5iPnO4ZJ1IbFX994+EbYuM/4InYLTwp3x4HhgH9ocKC/z9e7b29P956uzg6vp72tdbe7ZVfzzh3bt229b8vmhnqXs652w/qqynuldQ57eWmxxVy0oiA/z5SbYzSIAoFaqpKgRxUrabFXljyS3FlXSz3lkfa6Wo/kDapUpio+DFVSZycnSbJKg1Stwoe8jBxU3Sg5dpukW5N0L0kSC90JO5kLiao/bZfoPBnu8yN8sl0KUPUKh/dy2FDFkRWIOByowaNi0VKP6p2OZDxBjJHMFuS3SW1Kfl0tzOYXIFiAkLpBSsySDbsIB4QNnu2zAphWMLeYqUcOq74+v6fd5nAE6mq71CKpnbOgjZtUc9rUXG6SRlnocILO1i5knpy3wGiwpjAsheWDflWUUTcjejKZJ9TiGrVaalerj/2qHDNX1Fqp3aPWMKvd/Ut+um+6JKqx0iLRzOeA6UhXLt9KkXVKTqXlc2CgKrSppN/vYJfNi7XOZLwS9WaCGXl+cWZUohYpM1tYmEl4sNzg86OJ+cUfnLCp3icDqiUYIdsDeure/m71nr4DflWo9NKIjBT8a5EcW22O4iUZ39exAcuCxcEKOxysDCfm3TCKiDrT59dwCqO2V8HtqgmoQpBxFrKcsiHGmclyltSDEva2e8CfUQ2VXWHJgxU/IaszozhdD7LGSBa16AubQ8qUFNNtrgCXpRhVVzhKVWMVFgm1livg3DCVjIUjRV9ojys2dFBVXEK3SWiG2fFInqD+Nx0pRwMUC91Zow3CoF91tyPglvWOeWbrXaghB7Fh0XbeTNUlJdRSqXWpuywsT3TAz1V0NbW0TYVgSNdSXR6+r6gnE2zXQmC2pD7/69C0eGl2E7XNNcEmCLQzYWsbTlmVJ+MPj6n2oC2M+26M+m0O1R3ADgckvxJgY4cVqr5k48MR4LMy6O8ekLr7hv1b9UA0BjNnqPTcZkby2zQzOICqqdJE/YJNDKCgBQnUi4DUuhPvam6lCZcFC86pbHBbd1I/sUFWGsNQq6lHadflGH6LUSMbp7bOrLUchqKdtk6bI+DQrrpaAdlUd4waJlbUziwLjylkmHA+2zo5idWynA099UuKFJAiVHX7/Cw3Vh5eZb0YvOZ6rwZvwZYVC8sEDmRnEVZM1VtjW15ctYPjS2jnbeyuLJtmTFL3QIYZl3SDgJF3qcBG2L212MbPArahJTx7qQW3NN/QmVm3m23myHZmROoKZ6QB/04ujefJI7ZjzFcJdJPuwda6WjzaWmclcrxv1k2ODwz7X7fg78Ljg/5XBSK0BVsDs/ciz/86xS8NThUYlREZQhnCLPUjYuLyttfdADOca+AEjofmCXCaKUsjEJoXNJpFc1TFHblBQI5B47iz0gakmTTaDKfxaxZYydz5RrfJnecuFFYItlnCSK8i5Qf4OzaPwFwhWUFss6jVz8nzZGY2z23TJGZQwq1FeHzopuuhYf9cIX472/gdHbWyC8elPILNxq8VDw2zQflWIJIJBthmAyu2Bv+ISqRd2CZpFwaSU6jmS0qrWiC1MnoLo7do9BxGz8URJVaC6jPYe59K2AQc8DtwS9LVP7ZlLFdYpwJ4qGQsv67DilXie8Nb+Bu0lOx0XywRCgSTWGYtBBPJE02mvGIxTwwG8sQSAYSRAJS0WInZSi5ZyQUrOWUlj1rJiJUgkXL64WtW8o6VvMB5CSvptRI7Z2h01Uqe56w4V3NbST0XACv5hHNnOL2eU3Yscj+a2inO6OW8a5yuZn1oCpTrXOOGFribGc7F0FxZHw8sXb+XvZL6deg2+lc4jActNcXQVM7vxU3lrpFDDzQVl5CV24qbGuodm+8rltaZiVTsKJbWO0kNKV5ZRnZ80HT9AVub4Vy7reIfHmr4YLPN8Ezpe2THjbffyy348rBtM/9ZBr7Fy6JXfBvfCdbASffwKkLMq01l5rK1FavAFzCvsq8SCsVVqwpLSqy+QIml0NgXKLQuVBC1grxQQU5XkJkKkqggwQriqyBQQXbhw11B6isIrSCWCnKNy6FQNrGlrB7ApIClVALbeEYIkW2YEWbI0iJlpRWkqXHLfWVFRFpXVbxpSxMtLiPrcsocm6qIofnR8S3fra//3v6PfvKzCyR645lInJw5SD4syZz1lRRstTsvE+MXn94Y6yfnXvqzubPsTXBw8bLwPua6AQLuTY7c0tUroBSqN65wiCtXVvgCtpUWscAXyBWtMxtJYiMJbiS+jYRuJOc3kpGNpHcjyfYJWppY6E089m03w2ZRl+ZgsOs3N620NjVu3uQiTmEzRt64skxaXyVh8KXWlRWi8P7sn3tfrq9r6H7oh2cDysHGl0+PP+fauDnZN7R331PDLRIxPXl6bcm//kH7i8c2rXW0h7zfOmX/6aTL175t3+pGZ9t+YPmUYj51hm+DFTrc6/OLinLvEcWV5YbCgkJfIC+3wFwKUNwXAOvz5UQtJy3lxFXOUkhmp6mpic8Thl+yrbGR1dy4rmpzsbS5hTSVNZVJxaWYAys/2RccefgRpeXnP99Rv31A+sPS5LjwVN36Dz4YvP7o7lbL7nI7jwfnadXZ8O/mb4yYd34Odu0d7+/b3/3ZzV/wi5f5jmcvgIJOQr1cxw0P3L8kRG772W/M2YYnxS+hUjwJPnEtDArbsHHs+iHZSl4g/8Y1jFCt2xTAgu8+BxH4kfi3IHJuBYkt2d2/5IOg5H4dFiAX39M0WAQbvg1qsAFljuuwEVbgO6sG5+C78/d0OBeO4XusBpvwPHPqcB4UkVYdzicx4tPhAlgjvLn0LxNO4Rc6vAI2iyYdLoLVYjOL3sDeqF4R79dhAtQg6rAARQZJh0XYYmjQYQPKjOuwEVYbntDhHKgw/KkO58Jnhgs6bIINxjkdzoM1xo90OF/42PifOlwAW03v63AhHMwr0OEV8GBe1lcRbMp7rz06Hk1HjylhGpbTMg3FE0eT0fFImm4IVdPG+oZ62hGPj08otC2eTMSTcjoajznz224Xa6T9aKJTTtfSrljI2RMdVTRZOqAko2P9yvjUhJzcnQopsbCSpHX0donb8f1KMsWQRmeDc9NN5u2y0RS+5aWTcliZlJOHaXzs1jhoUhmPptJKEonRGB1yDjipT04rsTSVY2E6uKTYOzYWDSmcGFKSaRmF4+kIRvrgVDKaCkdDzFvKuZTAsmoMpJVphe6V02klFY+1yin0hZENRmPxVC09EomGIvSInKJhJRUdjyFz9Ci9VYciV8ZcYrH4NJqcVmox7rGkkopEY+M0xVLWtWk6IqdZ0pNKOhkNyRMTR7FlkwnUGsUeHYmmI+h4UknRfcoR2h+flGPfd2qhYG3GsKY0OplIxqd5jHWpUFJRYuhMDsuj0YloGq1F5KQcwoph2aKhFK8IFoIm5FidZyoZTygY6f0dPTcFMUCtmqn4xDR6ZtIxRQkzjxj2tDKBSuh4Ih4/zPIZiycx0HA6Urcs8rF4LI2qcSqHw5g4VisemppkfcIyp7PByaFkHHmJCTmNViZTzkg6ndjuch05csQp660JYWecaNl1N176aELR+5FkViYnerD9Mda6Kd5flsRAVw/tTWB9vBgc1QVqaXYyG5wNugssYzSRTjlT0QlnPDnu6vX2QDtEYRxXGtcxUCAMFJeMuIxQCOKQgKOQ5FIRpFL8ogvhoUihEeqhAReFDpSKI38C9Sm0IZxELXaXud04xMAJ+Zxzd2uNCPXrUXRy7VqEulA/hBZ6UG8UucvtUhjglCges0xzHKYwDhkpuyGFWgrKhLkEhTpc32Tjm/j7OZRa4jRiXA24Nt1R85vsRtES5ZVOcw6LdJJHfxhpcdS7Wz0oyim8eynkKBwLc6vM9hBKDHApH9dklUhzbzEuNXgHj73ocQz1Q7yTWckQt80mQrMcRzii1/RBrHeSRxDmetncUuj5qx2482wM8Oimuc+9nM7wFOe1Ip7S89JqNsijiCOV1eIIRsL8Rjgs83qGuTabsZiuOYpTR+/qh+q6st6XGPcxrUfJdGr1eo/xe4r7jaEPyuPTunyrb8rrJPOqa52eRG6ay4aQPoGfo/oum8SqaL5G9X10hO/KiJ7xJLdLYR8+j/CpiPO+xRzreI9vVkWbmzF9TinXTSAc51lk61jHe8MyUXikDJL5zh9FjQnuW4stwqdD5r1V9F6neQbZeoX1TFnUCU6pAw+fC7bfFb2m9+M50XNHi1oFl88m68kEjze1zHaMRxteylGrNpOa0D1pGU/w8+jwUn/G+LxpFQ1za3VfU/MxXpu07jXOIwrjR+u4Nltx1J3i/dD2kzbN6a9UTub1jet6CX4qpfVYJvn+iPAJTMB2/GHpwujYx8nncPmuCel7xqnH7Ppf67G4EryCy/dHcimWSYyxR9/9saVdN7Vs/2Y7MYBnUA8/LxL6/Hj1ytHbLLBdc/uZ2cDPzFuz0KYxiniax5PitXTyHMaR34seerT/lrvLNZvn2z1KFCAkQsbhHrCTIOwjIzBEdkMzcePTjbxWfLYhzp5O0gwzKNeM9F2I70T6Djw77XhvwdWL6xQuAy5Noh4lXPh06Xgd4rWo8Q7eCV+M2oJU9tyDeCc+O/SnF+kefHp0vAtxfEKQ5OKP8BZ+v0AM7jly6Tp55zqh18mjXxLfl2Tm09OfCv9xrdp+/tqFa0Lv1ZGr56+K9VeJ+SoxwRXLFd+V4JXElReu5OSbL5NC+HdS/MtLW+2fNF8c+pfmj4fgImZ2sf6i7+LMRfWi8SIRhz4WrXbLAl2oX0gszCy8u3Bp4dqCaebN028Kf/2Gy25+w/6GYJ/rnXt0Tgy+RMwv2V8SfM8FnxNOnyPmc/ZzrnPis2ed9rMdFfZnnl5vv/T0taeF+cWFuadXFHvfIL2kB5qxhvvmxEX7+d1lZC+mZca7HZcLVy+uOK5TuPCdB8XtuFykx71VHPljUnDGdqbmzMNnTpwxJh6fefz04+LMY6cfE85PX5gWUr5qezxWY491bLSvaiofym0Sh3LQDXp3d41WbvAGR9z2ERQ6MFxvH+6ott/TVDJkxIQNKGgW7WKL2CvGxVPiBTHX1O+rsPfhuuS75hPcvrxCr7nX3uvqFecXL7mVbgda25PYM7NH7PJW2zs7ttrNHfYOV8c7HZ90XO3IGekgz+Of97z3gld0e6tdXre3wuFd02kbsjaVDRUT85ClyTwkEGx0Ewy5zItmwWweMT9qFs3QAsKMlRjJPDk9OzhQU9M9n7vY362afAdUclytHGB3d9+wmnNchaHhA/5ZQv4o8NjJk9C6tlttHPCrwbWBbjWMgJsBMwhY1s5aoTWQSqVr+EVqahCewjvUTNUg8VBKo8ISH2pSJIVHVIorkRomoOEE7zWMhwSmR1D7UArYjTFrNCWmndLNcWXtxoHyQ/8NHT4cpAplbmRzdHJlYW0KZW5kb2JqCgo2IDAgb2JqCjQ2MjgKZW5kb2JqCgo3IDAgb2JqCjw8L1R5cGUvRm9udERlc2NyaXB0b3IvRm9udE5hbWUvQkFBQUFBK0xpYmVyYXRpb25TZXJpZgovRmxhZ3MgNAovRm9udEJCb3hbLTU0MyAtMzAzIDEyNzggOTgyXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgODkxCi9EZXNjZW50IC0yMTYKL0NhcEhlaWdodCA5ODEKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFIKPj4KZW5kb2JqCgo4IDAgb2JqCjw8L0xlbmd0aCAyNDAvRmlsdGVyL0ZsYXRlRGVjb2RlPj4Kc3RyZWFtCnicXVDLasMwELzrK/aYHIJsx2kvRhASAj70Qd1+gCytXUEtCVk++O+7ktMWepCYYXaG2eWX9tpaE/lrcKrDCIOxOuDslqAQehyNZWUF2qh4Z/lXk/SMk7db54hTawfXNIy/kTbHsMLurF2Pe8ZfgsZg7Ai7j0tHvFu8/8IJbYSCCQEaB8p5kv5ZTsiz69Bqkk1cD2T5G3hfPUKVeblVUU7j7KXCIO2IrCkKAc3tJhha/U+rN0c/qE8ZaLKkyaI41YJwlfHDKeFjxo/HhOsN1znv7kzJafWfxqCWEKhtvk+umQoai78n9M4nV37ft5d0YgplbmRzdHJlYW0KZW5kb2JqCgo5IDAgb2JqCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1RydWVUeXBlL0Jhc2VGb250L0JBQUFBQStMaWJlcmF0aW9uU2VyaWYKL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciA0Ci9XaWR0aHNbNzc3IDYxMCA0NDMgMzg5IDI3NyBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwvRjEgOSAwIFIKPj4KZW5kb2JqCgoxMSAwIG9iago8PC9Gb250IDEwIDAgUgovUHJvY1NldFsvUERGL1RleHRdCj4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDYxMiA3OTJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgo0IDAgb2JqCjw8L1R5cGUvUGFnZXMKL1Jlc291cmNlcyAxMSAwIFIKL01lZGlhQm94WyAwIDAgNjEyIDc5MiBdCi9LaWRzWyAxIDAgUiBdCi9Db3VudCAxPj4KZW5kb2JqCgoxMiAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgNCAwIFIKL09wZW5BY3Rpb25bMSAwIFIgL1hZWiBudWxsIG51bGwgMF0KL0xhbmcoZW4tVVMpCj4+CmVuZG9iagoKMTMgMCBvYmoKPDwvQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEMwMDY5MDA2MjAwNzIwMDY1MDA0RjAwNjYwMDY2MDA2OTAwNjMwMDY1MDAyMDAwMzcwMDJFMDAzMj4KL0NyZWF0aW9uRGF0ZShEOjIwMjIwNTIzMDczODM3LTA3JzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNAowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDU3MTUgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMTk2IDAwMDAwIG4gCjAwMDAwMDU4NTggMDAwMDAgbiAKMDAwMDAwMDIxNiAwMDAwMCBuIAowMDAwMDA0OTI4IDAwMDAwIG4gCjAwMDAwMDQ5NDkgMDAwMDAgbiAKMDAwMDAwNTE0NCAwMDAwMCBuIAowMDAwMDA1NDUzIDAwMDAwIG4gCjAwMDAwMDU2MjggMDAwMDAgbiAKMDAwMDAwNTY2MCAwMDAwMCBuIAowMDAwMDA1OTU3IDAwMDAwIG4gCjAwMDAwMDYwNTQgMDAwMDAgbiAKdHJhaWxlcgo8PC9TaXplIDE0L1Jvb3QgMTIgMCBSCi9JbmZvIDEzIDAgUgovSUQgWyA8ODREQjY2QjEwREU5OTRGNzA1ODlCQTNCRjUzODE4RDg+Cjw4NERCNjZCMTBERTk5NEY3MDU4OUJBM0JGNTM4MThEOD4gXQovRG9jQ2hlY2tzdW0gLzg3MTVEQTJGQzEyOEM2RUY4NzlFREY4RUZGMjRBQTc0Cj4+CnN0YXJ0eHJlZgo2MjI5CiUlRU9GCg==",
            "title": "UploadTest.pdf"
          },
          "provision": {
            "period": {
              "start": "2022-05-15",
              "end": "2022-10-10"
            }
          }
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Consent"
        payload = {
          "resourceType": "Consent",
          "status": "active",
          "scope": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/consentscope",
                  "code": "patient-privacy"
                }
            ]
          },
          "category": [
            {
              "coding": [
                {
                  "system": "ConsentCoding_System_ConfigureInAdmin",
                  "code": "ConsentCoding_Code_ConfigureInAdmin",
                  "display": "ConsentCoding_Display_ConfigureInAdmin"
                }
              ]
            }
          ],
          "patient": {
              "reference": "Patient/5350cd20de8a470aa570a852859ac87e",
              "type": "Patient"
          },
          "sourceAttachment": {
              "contentType": "application/pdf",
              "data": "JVBERi0xLjYKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCXKuwqEQAxG4T5P8dcLxiS6MyMMUwha2AkBi8VuL52gja+/gpzia46w4qQdAmGxhKDKXVTE7vb40PLAdh9Xx496p2fghGgtB/gb9ahQg39fWbSElMWKZmlKZVnasvpEg9NMM/7+cxdrCmVuZHN0cmVhbQplbmRvYmoKCjMgMCBvYmoKMTA2CmVuZG9iagoKNSAwIG9iago8PC9MZW5ndGggNiAwIFIvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aDEgODE4ND4+CnN0cmVhbQp4nOU5fXATV36/tyvZ8geW7NjCILCe2NhgbEv+AMKXsbAt2cYGy19EMgRrLa0tBVtSJdkEcpn42iZhRCgcuSYlYSbpTC+T3KTDOk5b5yYNzl3T9nq9S9I0c5NLaJi5u2lnCgPNJWnncuD+3tuVMYSQaaf/deW3+/v+fk9aSCenFCiEGRDBHZqUE6VGgwAA/whASkLTadrcW7YD4UsAwj+NJcYnn/2rg58BGF4DyH1tfOLo2Or+l9MAhREA8d2IIodPNW6rAbBsRRtbIkjovnE0F/EE4vdGJtMPXSSLJYh/F/HSiXhIpuIoQfwlxAsn5YcSDsN29G9B+0Bj8qTyX+d+FEb8nwEKUol4Cn2JyFrTyfiJpJLoeXb0bcSZ/9NII/hhVyGCOQwXRAP8f76MJ6EMOo3NYIYEv99yia/AKjgLsHiZYTfvN3oWf/t/GYVJe/wJvAivwUn4EB7QGV7wQRSmkLL8egveQyq7fDAM34fM15h9BeaRr8kF4RTL5I6XD56BOfi7W7z4YBIexlj+Aj4kDfBjHJU4fEpM8G14G61+irS9dzIlFOFtjINjy6gfwXPCCdgj/AqRs4wjuAQL/A2cI4fQchrzPLmU8c6vGH0CHsH7AERgGmF+GZt/9wvIW/wNZvUI7IHfh90wsUzjDfK8mI/9G4TnsaZvcZory8ztFB8U/lIQrj+FyHdgHJdMMHfhpLj7ayr0P77EIVhBqsVKyLsTV9gE5hu/FRoXPxPvhXwYWryWpS12L/5GlG/EDCOGNcZmw0/u5iPnO4ZJ1IbFX994+EbYuM/4InYLTwp3x4HhgH9ocKC/z9e7b29P956uzg6vp72tdbe7ZVfzzh3bt229b8vmhnqXs652w/qqynuldQ57eWmxxVy0oiA/z5SbYzSIAoFaqpKgRxUrabFXljyS3FlXSz3lkfa6Wo/kDapUpio+DFVSZycnSbJKg1Stwoe8jBxU3Sg5dpukW5N0L0kSC90JO5kLiao/bZfoPBnu8yN8sl0KUPUKh/dy2FDFkRWIOByowaNi0VKP6p2OZDxBjJHMFuS3SW1Kfl0tzOYXIFiAkLpBSsySDbsIB4QNnu2zAphWMLeYqUcOq74+v6fd5nAE6mq71CKpnbOgjZtUc9rUXG6SRlnocILO1i5knpy3wGiwpjAsheWDflWUUTcjejKZJ9TiGrVaalerj/2qHDNX1Fqp3aPWMKvd/Ut+um+6JKqx0iLRzOeA6UhXLt9KkXVKTqXlc2CgKrSppN/vYJfNi7XOZLwS9WaCGXl+cWZUohYpM1tYmEl4sNzg86OJ+cUfnLCp3icDqiUYIdsDeure/m71nr4DflWo9NKIjBT8a5EcW22O4iUZ39exAcuCxcEKOxysDCfm3TCKiDrT59dwCqO2V8HtqgmoQpBxFrKcsiHGmclyltSDEva2e8CfUQ2VXWHJgxU/IaszozhdD7LGSBa16AubQ8qUFNNtrgCXpRhVVzhKVWMVFgm1livg3DCVjIUjRV9ojys2dFBVXEK3SWiG2fFInqD+Nx0pRwMUC91Zow3CoF91tyPglvWOeWbrXaghB7Fh0XbeTNUlJdRSqXWpuywsT3TAz1V0NbW0TYVgSNdSXR6+r6gnE2zXQmC2pD7/69C0eGl2E7XNNcEmCLQzYWsbTlmVJ+MPj6n2oC2M+26M+m0O1R3ADgckvxJgY4cVqr5k48MR4LMy6O8ekLr7hv1b9UA0BjNnqPTcZkby2zQzOICqqdJE/YJNDKCgBQnUi4DUuhPvam6lCZcFC86pbHBbd1I/sUFWGsNQq6lHadflGH6LUSMbp7bOrLUchqKdtk6bI+DQrrpaAdlUd4waJlbUziwLjylkmHA+2zo5idWynA099UuKFJAiVHX7/Cw3Vh5eZb0YvOZ6rwZvwZYVC8sEDmRnEVZM1VtjW15ctYPjS2jnbeyuLJtmTFL3QIYZl3SDgJF3qcBG2L212MbPArahJTx7qQW3NN/QmVm3m23myHZmROoKZ6QB/04ujefJI7ZjzFcJdJPuwda6WjzaWmclcrxv1k2ODwz7X7fg78Ljg/5XBSK0BVsDs/ciz/86xS8NThUYlREZQhnCLPUjYuLyttfdADOca+AEjofmCXCaKUsjEJoXNJpFc1TFHblBQI5B47iz0gakmTTaDKfxaxZYydz5RrfJnecuFFYItlnCSK8i5Qf4OzaPwFwhWUFss6jVz8nzZGY2z23TJGZQwq1FeHzopuuhYf9cIX472/gdHbWyC8elPILNxq8VDw2zQflWIJIJBthmAyu2Bv+ISqRd2CZpFwaSU6jmS0qrWiC1MnoLo7do9BxGz8URJVaC6jPYe59K2AQc8DtwS9LVP7ZlLFdYpwJ4qGQsv67DilXie8Nb+Bu0lOx0XywRCgSTWGYtBBPJE02mvGIxTwwG8sQSAYSRAJS0WInZSi5ZyQUrOWUlj1rJiJUgkXL64WtW8o6VvMB5CSvptRI7Z2h01Uqe56w4V3NbST0XACv5hHNnOL2eU3Yscj+a2inO6OW8a5yuZn1oCpTrXOOGFribGc7F0FxZHw8sXb+XvZL6deg2+lc4jActNcXQVM7vxU3lrpFDDzQVl5CV24qbGuodm+8rltaZiVTsKJbWO0kNKV5ZRnZ80HT9AVub4Vy7reIfHmr4YLPN8Ezpe2THjbffyy348rBtM/9ZBr7Fy6JXfBvfCdbASffwKkLMq01l5rK1FavAFzCvsq8SCsVVqwpLSqy+QIml0NgXKLQuVBC1grxQQU5XkJkKkqggwQriqyBQQXbhw11B6isIrSCWCnKNy6FQNrGlrB7ApIClVALbeEYIkW2YEWbI0iJlpRWkqXHLfWVFRFpXVbxpSxMtLiPrcsocm6qIofnR8S3fra//3v6PfvKzCyR645lInJw5SD4syZz1lRRstTsvE+MXn94Y6yfnXvqzubPsTXBw8bLwPua6AQLuTY7c0tUroBSqN65wiCtXVvgCtpUWscAXyBWtMxtJYiMJbiS+jYRuJOc3kpGNpHcjyfYJWppY6E089m03w2ZRl+ZgsOs3N620NjVu3uQiTmEzRt64skxaXyVh8KXWlRWi8P7sn3tfrq9r6H7oh2cDysHGl0+PP+fauDnZN7R331PDLRIxPXl6bcm//kH7i8c2rXW0h7zfOmX/6aTL175t3+pGZ9t+YPmUYj51hm+DFTrc6/OLinLvEcWV5YbCgkJfIC+3wFwKUNwXAOvz5UQtJy3lxFXOUkhmp6mpic8Thl+yrbGR1dy4rmpzsbS5hTSVNZVJxaWYAys/2RccefgRpeXnP99Rv31A+sPS5LjwVN36Dz4YvP7o7lbL7nI7jwfnadXZ8O/mb4yYd34Odu0d7+/b3/3ZzV/wi5f5jmcvgIJOQr1cxw0P3L8kRG772W/M2YYnxS+hUjwJPnEtDArbsHHs+iHZSl4g/8Y1jFCt2xTAgu8+BxH4kfi3IHJuBYkt2d2/5IOg5H4dFiAX39M0WAQbvg1qsAFljuuwEVbgO6sG5+C78/d0OBeO4XusBpvwPHPqcB4UkVYdzicx4tPhAlgjvLn0LxNO4Rc6vAI2iyYdLoLVYjOL3sDeqF4R79dhAtQg6rAARQZJh0XYYmjQYQPKjOuwEVYbntDhHKgw/KkO58Jnhgs6bIINxjkdzoM1xo90OF/42PifOlwAW03v63AhHMwr0OEV8GBe1lcRbMp7rz06Hk1HjylhGpbTMg3FE0eT0fFImm4IVdPG+oZ62hGPj08otC2eTMSTcjoajznz224Xa6T9aKJTTtfSrljI2RMdVTRZOqAko2P9yvjUhJzcnQopsbCSpHX0donb8f1KMsWQRmeDc9NN5u2y0RS+5aWTcliZlJOHaXzs1jhoUhmPptJKEonRGB1yDjipT04rsTSVY2E6uKTYOzYWDSmcGFKSaRmF4+kIRvrgVDKaCkdDzFvKuZTAsmoMpJVphe6V02klFY+1yin0hZENRmPxVC09EomGIvSInKJhJRUdjyFz9Ci9VYciV8ZcYrH4NJqcVmox7rGkkopEY+M0xVLWtWk6IqdZ0pNKOhkNyRMTR7FlkwnUGsUeHYmmI+h4UknRfcoR2h+flGPfd2qhYG3GsKY0OplIxqd5jHWpUFJRYuhMDsuj0YloGq1F5KQcwoph2aKhFK8IFoIm5FidZyoZTygY6f0dPTcFMUCtmqn4xDR6ZtIxRQkzjxj2tDKBSuh4Ih4/zPIZiycx0HA6Urcs8rF4LI2qcSqHw5g4VisemppkfcIyp7PByaFkHHmJCTmNViZTzkg6ndjuch05csQp660JYWecaNl1N176aELR+5FkViYnerD9Mda6Kd5flsRAVw/tTWB9vBgc1QVqaXYyG5wNugssYzSRTjlT0QlnPDnu6vX2QDtEYRxXGtcxUCAMFJeMuIxQCOKQgKOQ5FIRpFL8ogvhoUihEeqhAReFDpSKI38C9Sm0IZxELXaXud04xMAJ+Zxzd2uNCPXrUXRy7VqEulA/hBZ6UG8UucvtUhjglCges0xzHKYwDhkpuyGFWgrKhLkEhTpc32Tjm/j7OZRa4jRiXA24Nt1R85vsRtES5ZVOcw6LdJJHfxhpcdS7Wz0oyim8eynkKBwLc6vM9hBKDHApH9dklUhzbzEuNXgHj73ocQz1Q7yTWckQt80mQrMcRzii1/RBrHeSRxDmetncUuj5qx2482wM8Oimuc+9nM7wFOe1Ip7S89JqNsijiCOV1eIIRsL8Rjgs83qGuTabsZiuOYpTR+/qh+q6st6XGPcxrUfJdGr1eo/xe4r7jaEPyuPTunyrb8rrJPOqa52eRG6ay4aQPoGfo/oum8SqaL5G9X10hO/KiJ7xJLdLYR8+j/CpiPO+xRzreI9vVkWbmzF9TinXTSAc51lk61jHe8MyUXikDJL5zh9FjQnuW4stwqdD5r1V9F6neQbZeoX1TFnUCU6pAw+fC7bfFb2m9+M50XNHi1oFl88m68kEjze1zHaMRxteylGrNpOa0D1pGU/w8+jwUn/G+LxpFQ1za3VfU/MxXpu07jXOIwrjR+u4Nltx1J3i/dD2kzbN6a9UTub1jet6CX4qpfVYJvn+iPAJTMB2/GHpwujYx8nncPmuCel7xqnH7Ppf67G4EryCy/dHcimWSYyxR9/9saVdN7Vs/2Y7MYBnUA8/LxL6/Hj1ytHbLLBdc/uZ2cDPzFuz0KYxiniax5PitXTyHMaR34seerT/lrvLNZvn2z1KFCAkQsbhHrCTIOwjIzBEdkMzcePTjbxWfLYhzp5O0gwzKNeM9F2I70T6Djw77XhvwdWL6xQuAy5Noh4lXPh06Xgd4rWo8Q7eCV+M2oJU9tyDeCc+O/SnF+kefHp0vAtxfEKQ5OKP8BZ+v0AM7jly6Tp55zqh18mjXxLfl2Tm09OfCv9xrdp+/tqFa0Lv1ZGr56+K9VeJ+SoxwRXLFd+V4JXElReu5OSbL5NC+HdS/MtLW+2fNF8c+pfmj4fgImZ2sf6i7+LMRfWi8SIRhz4WrXbLAl2oX0gszCy8u3Bp4dqCaebN028Kf/2Gy25+w/6GYJ/rnXt0Tgy+RMwv2V8SfM8FnxNOnyPmc/ZzrnPis2ed9rMdFfZnnl5vv/T0taeF+cWFuadXFHvfIL2kB5qxhvvmxEX7+d1lZC+mZca7HZcLVy+uOK5TuPCdB8XtuFykx71VHPljUnDGdqbmzMNnTpwxJh6fefz04+LMY6cfE85PX5gWUr5qezxWY491bLSvaiofym0Sh3LQDXp3d41WbvAGR9z2ERQ6MFxvH+6ott/TVDJkxIQNKGgW7WKL2CvGxVPiBTHX1O+rsPfhuuS75hPcvrxCr7nX3uvqFecXL7mVbgda25PYM7NH7PJW2zs7ttrNHfYOV8c7HZ90XO3IGekgz+Of97z3gld0e6tdXre3wuFd02kbsjaVDRUT85ClyTwkEGx0Ewy5zItmwWweMT9qFs3QAsKMlRjJPDk9OzhQU9M9n7vY362afAdUclytHGB3d9+wmnNchaHhA/5ZQv4o8NjJk9C6tlttHPCrwbWBbjWMgJsBMwhY1s5aoTWQSqVr+EVqahCewjvUTNUg8VBKo8ISH2pSJIVHVIorkRomoOEE7zWMhwSmR1D7UArYjTFrNCWmndLNcWXtxoHyQ/8NHT4cpAplbmRzdHJlYW0KZW5kb2JqCgo2IDAgb2JqCjQ2MjgKZW5kb2JqCgo3IDAgb2JqCjw8L1R5cGUvRm9udERlc2NyaXB0b3IvRm9udE5hbWUvQkFBQUFBK0xpYmVyYXRpb25TZXJpZgovRmxhZ3MgNAovRm9udEJCb3hbLTU0MyAtMzAzIDEyNzggOTgyXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgODkxCi9EZXNjZW50IC0yMTYKL0NhcEhlaWdodCA5ODEKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFIKPj4KZW5kb2JqCgo4IDAgb2JqCjw8L0xlbmd0aCAyNDAvRmlsdGVyL0ZsYXRlRGVjb2RlPj4Kc3RyZWFtCnicXVDLasMwELzrK/aYHIJsx2kvRhASAj70Qd1+gCytXUEtCVk++O+7ktMWepCYYXaG2eWX9tpaE/lrcKrDCIOxOuDslqAQehyNZWUF2qh4Z/lXk/SMk7db54hTawfXNIy/kTbHsMLurF2Pe8ZfgsZg7Ai7j0tHvFu8/8IJbYSCCQEaB8p5kv5ZTsiz69Bqkk1cD2T5G3hfPUKVeblVUU7j7KXCIO2IrCkKAc3tJhha/U+rN0c/qE8ZaLKkyaI41YJwlfHDKeFjxo/HhOsN1znv7kzJafWfxqCWEKhtvk+umQoai78n9M4nV37ft5d0YgplbmRzdHJlYW0KZW5kb2JqCgo5IDAgb2JqCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1RydWVUeXBlL0Jhc2VGb250L0JBQUFBQStMaWJlcmF0aW9uU2VyaWYKL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciA0Ci9XaWR0aHNbNzc3IDYxMCA0NDMgMzg5IDI3NyBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwvRjEgOSAwIFIKPj4KZW5kb2JqCgoxMSAwIG9iago8PC9Gb250IDEwIDAgUgovUHJvY1NldFsvUERGL1RleHRdCj4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDYxMiA3OTJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgo0IDAgb2JqCjw8L1R5cGUvUGFnZXMKL1Jlc291cmNlcyAxMSAwIFIKL01lZGlhQm94WyAwIDAgNjEyIDc5MiBdCi9LaWRzWyAxIDAgUiBdCi9Db3VudCAxPj4KZW5kb2JqCgoxMiAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgNCAwIFIKL09wZW5BY3Rpb25bMSAwIFIgL1hZWiBudWxsIG51bGwgMF0KL0xhbmcoZW4tVVMpCj4+CmVuZG9iagoKMTMgMCBvYmoKPDwvQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEMwMDY5MDA2MjAwNzIwMDY1MDA0RjAwNjYwMDY2MDA2OTAwNjMwMDY1MDAyMDAwMzcwMDJFMDAzMj4KL0NyZWF0aW9uRGF0ZShEOjIwMjIwNTIzMDczODM3LTA3JzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNAowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDU3MTUgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMTk2IDAwMDAwIG4gCjAwMDAwMDU4NTggMDAwMDAgbiAKMDAwMDAwMDIxNiAwMDAwMCBuIAowMDAwMDA0OTI4IDAwMDAwIG4gCjAwMDAwMDQ5NDkgMDAwMDAgbiAKMDAwMDAwNTE0NCAwMDAwMCBuIAowMDAwMDA1NDUzIDAwMDAwIG4gCjAwMDAwMDU2MjggMDAwMDAgbiAKMDAwMDAwNTY2MCAwMDAwMCBuIAowMDAwMDA1OTU3IDAwMDAwIG4gCjAwMDAwMDYwNTQgMDAwMDAgbiAKdHJhaWxlcgo8PC9TaXplIDE0L1Jvb3QgMTIgMCBSCi9JbmZvIDEzIDAgUgovSUQgWyA8ODREQjY2QjEwREU5OTRGNzA1ODlCQTNCRjUzODE4RDg+Cjw4NERCNjZCMTBERTk5NEY3MDU4OUJBM0JGNTM4MThEOD4gXQovRG9jQ2hlY2tzdW0gLzg3MTVEQTJGQzEyOEM2RUY4NzlFREY4RUZGMjRBQTc0Cj4+CnN0YXJ0eHJlZgo2MjI5CiUlRU9GCg==",
              "title": "UploadTest.pdf"
          },
          "provision": {
              "period": {
                  "start": "2022-05-15",
                  "end": "2022-10-10"
              }
          }
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Consent/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Consent/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Consent",
          "id": "a9d3c0d9-e87a-4737-b909-ac81ee62f9a0",
          "status": "inactive",
          "scope": {
              "text": "Unknown"
          },
          "category": [
            {
              "coding": [
                {
                  "system": "internal",
                  "display": "Restraints"
                }
              ]
            }
          ],
          "patient": {
              "reference": "Patient/2c4b29a411b043bfb1c34c8c3683c7ca",
              "type": "Patient"
          },
          "dateTime": "2022-04-13T14:43:32.317476+00:00",
          "sourceAttachment": {
              "url": "https://fumage-example.canvasmedical.com/Consent/a9d3c0d9-e87a-4737-b909-ac81ee62f9a0/files/sourceAttachment"
          },
          "provision": {
              "period": {
                  "start": "2022-04-13",
                  "end": "2022-12-31"
              }
          }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
            "resourceType": "OperationOutcome",
            "issue": [
                {
                    "severity": "error",
                    "code": "not-found",
                    "details": {
                        "text": "Unknown Consent resource '7d1ce256fcd7408193b0459650937a07'"
                    }
                }
            ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Consent?patient=Patient/2c4b29a411b043bfb1c34c8c3683c7ca' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Consent?patient=Patient/2c4b29a411b043bfb1c34c8c3683c7ca"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Bundle",
          "type": "searchset",
          "total": 486,
          "link": [
            {
              "relation": "self",
              "url": "/Consent?_count=2&_offset=0"
            },
            {
              "relation": "first",
              "url": "/Consent?_count=2&_offset=0"
            },
            {
              "relation": "next",
              "url": "/Consent?_count=2&_offset=2"
            },
            {
              "relation": "last",
              "url": "/Consent?_count=2&_offset=484"
            }
          ],
          "entry": [
            {
              "resource": {
                  "resourceType": "Consent",
                  "id": "a9d3c0d9-e87a-4737-b909-ac81ee62f9a0",
                  "status": "inactive",
                  "scope": {
                      "text": "Unknown"
                  },
                  "category": [
                    {
                      "coding": [
                          {
                            "system": "internal",
                            "display": "Restraints"
                          }
                      ]
                    }
                  ],
                  "patient": {
                      "reference": "Patient/2c4b29a411b043bfb1c34c8c3683c7ca",
                      "type": "Patient"
                  },
                  "dateTime": "2022-04-13T14:43:32.317476+00:00",
                  "sourceAttachment": {
                      "url": "https://fumage-example.canvasmedical.com/Consent/a9d3c0d9-e87a-4737-b909-ac81ee62f9a0/files/sourceAttachment"
                  },
                  "provision": {
                      "period": {
                          "start": "2022-04-13",
                          "end": "2022-12-31"
                      }
                  }
              }
            },
            {
              "resource": {
                "resourceType": "Consent",
                "id": "38a78199-e05f-4967-a203-aa6a1fc1b6da",
                "status": "active",
                "scope": {
                    "text": "Unknown"
                },
                "category": [
                    {
                      "coding": [
                        {
                          "system": "internal",
                          "display": "Photo"
                        }
                      ]
                    }
                ],
                "patient": {
                    "reference": "Patient/2c4b29a411b043bfb1c34c8c3683c7ca",
                    "type": "Patient"
                },
                "dateTime": "2022-04-13T14:45:12.460858+00:00",
                "provision": {
                    "period": {
                        "start": "2022-04-11"
                    }
                }
              }
            }
          ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/consent/


----- BEGIN PAGE https://docs.canvasmedical.com/api/coverage/
### 
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html>
### Endpoints
post /Coverage get /Coverage/{id} put /Coverage/{id} get /Coverage
post
/Coverage
#### Coverage create
### Attributes
resourceType 
string 
The FHIR Resource name.
identifier 
array[json] required
An identifier for the insured of an insurance policy, usually assigned by the insurance carrier.
Click to view child attributes
type 
json required
Insurance member ID description
Click to view child attributes
system 
required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0203 
code 
required
The code of the insurance member ID description.
**Value Options Supported:**
  - MB 
display 
The display name of the coding.
value 
string required
Insurance member ID value
status 
enum [ active | cancelled ] required
The status of the Coverage.   
In Canvas, the status of `active` means it appears in the Patient's Profile page either under the main or other coverage sections, while a status of `cancelled` means it was removed and no longer appears on the page. An expired coverage will still show as `active`, so be sure to set/read the `period.end` attribute.
Currently there is no way to create a coverage that appears under the "Other Coverages" section on the Patient Profile. All coverages created with `active` will appear as the primary, secondary, tertiary, etc coverage depending on the order number. Coverages created with a `cancelled` status will not appear on the UI, but can still be read out.
type 
json 
Type of coverage, such as medical, workers compensation, self pay, etc.  
In order for this value to display on the Canvas UI, the coverage type needs to be configured for the specific payor via our insurer settings. To get to these settings, see this [Pylon article](https://help.canvasmedical.com/articles/5877696655-patient-coverages#managing-insurers-68).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-selfpay 
  - http://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string required
The code of the coverage type.
**Value Options Supported:**
  - pay 
  - ANNU 
  - AUTOPOL 
  - CHAR 
  - COL 
  - CRIME 
  - DENTAL 
  - DENTPRG 
  - DIS 
  - DISEASE 
  - DRUGPOL 
  - EAP 
  - EWB 
  - ENDRENAL 
  - EHCPOL 
  - FLEXP 
  - GOVEMP 
  - HIP 
  - HMO 
  - HSAPOL 
  - HIRISK 
  - HIVAIDS 
  - IND 
  - LIFE 
  - LTC 
  - MCPOL 
  - MANDPOL 
  - MENTPOL 
  - MENTPRG 
  - MILITARY 
  - POS 
  - PPO 
  - PNC 
  - DISEASEPRG 
  - PUBLICPOL 
  - REI 
  - RETIRE 
  - SAFNET 
  - SOCIAL 
  - SUBSIDIZ 
  - SUBSIDMC 
  - SUBSUPP 
  - SUBPOL 
  - SUBPRG 
  - SURPL 
  - TLIFE 
  - UMBRL 
  - UNINSMOT 
  - ULIFE 
  - VET 
  - VISPOL 
  - CANPRG 
  - WCBPOL 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Pay 
  - Annuity policy 
  - Automobile 
  - Charity program 
  - Collision coverage policy 
  - Crime victim program 
  - Dental care policy 
  - Dental program 
  - Disability insurance policy 
  - Disease specific policy 
  - Drug policy 
  - Employee assistance program 
  - Employee welfare benefit plan policy 
  - End renal program 
  - Extended healthcare 
  - Flexible benefit plan policy 
  - Government employee health program 
  - Health insurance plan policy 
  - Health maintenance organization policy 
  - Health spending account 
  - High risk pool program 
  - HIV-AIDS program 
  - Indigenous peoples health program 
  - Life insurance policy 
  - Long term care policy 
  - Managed care policy 
  - Mandatory health program 
  - Mental health policy 
  - Mental health program 
  - Military health program 
  - Point of service policy 
  - Preferred provider organization policy 
  - Property and casualty insurance policy 
  - Public health program 
  - Public healthcare 
  - Reinsurance policy 
  - Retiree health program 
  - Safety net clinic program 
  - Social service program 
  - Subsidized health program 
  - Subsidized managed care program 
  - Subsidized supplemental health program 
  - Substance use policy 
  - Substance use program 
  - Surplus line insurance policy 
  - Term life insurance policy 
  - Umbrella liability insurance policy 
  - Uninsured motorist policy 
  - Universal life insurance policy 
  - Veteran health program 
  - Vision care policy 
  - Women's cancer detection program 
  - Worker's compensation 
subscriber 
json required
Who was signed up for or 'owns' the Coverage.
Click to view child attributes
reference 
string required
The reference string of the patient subscriber in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
subscriberId 
string 
ID assigned to the subscriber
beneficiary 
json required
Who benefits from the coverage; the patient when products or services are provided.
Click to view child attributes
reference 
string required
The reference string of the patient beneficiary in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
relationship 
json required
The relationship of beneficiary (patient) to the subscriber.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/subscriber-relationship 
code 
string 
The code of the relationship.
**Value Options Supported:**
  - child 
  - spouse 
  - other 
  - self 
  - injured 
display 
string 
The display name of the coding.
period 
json 
If the start date is missing for a create/update interaction, it will be set to the current date of ingestion.
Click to view child attributes
start 
date 
Starting time with inclusive boundary
end 
date 
End time with inclusive boundary, if not ongoing.
payor 
array[json] required
Issuer of the policy.
Two methods for specifying this data are supported:
  - sending an [**Organization**](/api/organization) reference in `payor[0].reference`
        ```json
          "payor": [
             {
                 "reference": "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728",
                 "type": "Organization",
                 "display": "Medicare Advantage"
             }
           ],
        ```
  - sending a `payor[0].identifier.value` corresponding to the Coverage's payor id. For now, these values can only be found and updated in the [Insurers Admin view](https://canvas-medical.help.usepylon.com/articles/8126548200-managing-insurers) in Canvas. 
        ```json
          "payor": [
           {
             "identifier": {
               "system": "https://www.claim.md/services/era/",
               "value": "13162"
             },
             "display": "1199 National Benefit Fund"
           }
         ],
        ```
A `reference` or `identifier.value` is required in a Create/Update.
Click to view child attributes
reference 
string 
The Organization reference to the Coverage's payor in the format "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728"
type 
string 
Type the reference refers to (e.g. "Organization").
display 
string 
The display name of the payor.
identifier 
json 
Logical reference, when literal reference is not known.
Click to view child attributes
value 
string required
The value that is unique. These values can only be found and updated in the [Insurers Admin view](https://help.canvasmedical.com/articles/5877696655-patient-coverages#managing-insurers-68) in Canvas.
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - https://www.claim.md/services/era/ 
class 
json 
Additional coverage classifications.  
Only plan and group will be visible in the Canvas UI.
Click to view child attributes
type 
json required
Type of class such as 'group' or 'plan'.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-class 
code 
string required
The code of the class.
**Value Options Supported:**
  - plan 
  - subplan 
  - group 
  - subgroup 
value 
string 
Value associated with the type, such as plan or group number.
name 
string 
Human readable description of the type and value, such as plan name or group name.
order 
number [ 1-5 ] required
The order in which coverages should be used when adjudicating claims.
The order must between 1 and 5, inclusive.  
If multiple coverages for a patient are created with the same order number, the older one will be bumped down in rank, and the new one will take that rank.  
If this leads to multiple coverages being incremented to 5, the oldest (first to be inputted into Canvas) of the coverages at this rank will be displayed on the Canvas UI.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Coverage/{id}
#### Coverage read
### Path Parameters
id required
string 
The unique identifier for the Coverage   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Coverage.
identifier 
array[json] 
An identifier for the insured of an insurance policy, usually assigned by the insurance carrier.
Click to view child attributes
type 
json 
Insurance member ID description
Click to view child attributes
system 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0203 
code 
The code of the insurance member ID description.
**Value Options Supported:**
  - MB 
display 
The display name of the coding.
value 
string 
Insurance member ID value
status 
enum [ active | cancelled ] 
The status of the Coverage.   
In Canvas, the status of `active` means it appears in the Patient's Profile page either under the main or other coverage sections, while a status of `cancelled` means it was removed and no longer appears on the page. An expired coverage will still show as `active`, so be sure to set/read the `period.end` attribute.
type 
json 
Type of coverage, such as medical, workers compensation, self pay, etc.  
In order for this value to display on the Canvas UI, the coverage type needs to be configured for the specific payor via our insurer settings. To get to these settings, see this [Pylon article](https://help.canvasmedical.com/articles/5877696655-patient-coverages#managing-insurers-68).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-selfpay 
  - http://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string 
The code of the coverage type.
**Value Options Supported:**
  - pay 
  - ANNU 
  - AUTOPOL 
  - CHAR 
  - COL 
  - CRIME 
  - DENTAL 
  - DENTPRG 
  - DIS 
  - DISEASE 
  - DRUGPOL 
  - EAP 
  - EWB 
  - ENDRENAL 
  - EHCPOL 
  - FLEXP 
  - GOVEMP 
  - HIP 
  - HMO 
  - HSAPOL 
  - HIRISK 
  - HIVAIDS 
  - IND 
  - LIFE 
  - LTC 
  - MCPOL 
  - MANDPOL 
  - MENTPOL 
  - MENTPRG 
  - MILITARY 
  - POS 
  - PPO 
  - PNC 
  - DISEASEPRG 
  - PUBLICPOL 
  - REI 
  - RETIRE 
  - SAFNET 
  - SOCIAL 
  - SUBSIDIZ 
  - SUBSIDMC 
  - SUBSUPP 
  - SUBPOL 
  - SUBPRG 
  - SURPL 
  - TLIFE 
  - UMBRL 
  - UNINSMOT 
  - ULIFE 
  - VET 
  - VISPOL 
  - CANPRG 
  - WCBPOL 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Pay 
  - Annuity policy 
  - Automobile 
  - Charity program 
  - Collision coverage policy 
  - Crime victim program 
  - Dental care policy 
  - Dental program 
  - Disability insurance policy 
  - Disease specific policy 
  - Drug policy 
  - Employee assistance program 
  - Employee welfare benefit plan policy 
  - End renal program 
  - Extended healthcare 
  - Flexible benefit plan policy 
  - Government employee health program 
  - Health insurance plan policy 
  - Health maintenance organization policy 
  - Health spending account 
  - High risk pool program 
  - HIV-AIDS program 
  - Indigenous peoples health program 
  - Life insurance policy 
  - Long term care policy 
  - Managed care policy 
  - Mandatory health program 
  - Mental health policy 
  - Mental health program 
  - Military health program 
  - Point of service policy 
  - Preferred provider organization policy 
  - Property and casualty insurance policy 
  - Public health program 
  - Public healthcare 
  - Reinsurance policy 
  - Retiree health program 
  - Safety net clinic program 
  - Social service program 
  - Subsidized health program 
  - Subsidized managed care program 
  - Subsidized supplemental health program 
  - Substance use policy 
  - Substance use program 
  - Surplus line insurance policy 
  - Term life insurance policy 
  - Umbrella liability insurance policy 
  - Uninsured motorist policy 
  - Universal life insurance policy 
  - Veteran health program 
  - Vision care policy 
  - Women's cancer detection program 
  - Worker's compensation 
text 
string 
Plain text representation of the coverage type.
subscriber 
json 
Who was signed up for or 'owns' the Coverage.
Click to view child attributes
reference 
string 
The reference string of the patient subscriber in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
subscriberId 
string 
ID assigned to the subscriber
beneficiary 
json 
Who benefits from the coverage; the patient when products or services are provided.
Click to view child attributes
reference 
string 
The reference string of the patient beneficiary in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
relationship 
json 
The relationship of beneficiary (patient) to the subscriber.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/subscriber-relationship 
code 
string 
The code of the relationship.
**Value Options Supported:**
  - child 
  - spouse 
  - other 
  - self 
  - injured 
  - parent 
  - common 
display 
string 
The display name of the coding.
text 
string 
The 2 character code that represents the patient relationship to the insured as defined by CMS.
**Value Options Supported:**
  - 18 (Self) 
  - 01 (Spouse) 
  - 19 (Natural Child, insured has financial responsibility) 
  - 43 (Natural Child, insured does not have financial responsibility), 
  - 17 (Step Child) 
  - 10 (Foster Child) 
  - 15 (Ward of the Court) 
  - 20 (Employee) 
  - 21 (Unknown) 
  - 22 (Handicapped Dependent) 
  - 39 (Organ donor) 
  - 40 (Cadaver donor) 
  - 05 (Grandchild) 
  - 07 (Niece/Nephew) 
  - 41 (Injured Plaintiff) 
  - 23 (Sponsored Dependent) 
  - 24 (Minor Dependent of a Minor Dependent) 
  - 32 (Mother) 
  - 33 (Father) 
  - 04 (Grandparent) 
  - 53 (Life Partner) 
  - 29 (Significant Other) 
  - G8 (Other) 
period 
json 
The period during which the Coverage is in force.  
A missing end date means the coverage continues to be in force.
Click to view child attributes
start 
date 
Starting time with inclusive boundary
end 
date 
End time with inclusive boundary, if not ongoing.
payor 
array[json] 
Issuer of the policy.
Click to view child attributes
reference 
string 
The Organization reference to the Coverage's payor in the format "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728"
type 
string 
Type the reference refers to (e.g. "Organization").
display 
string 
The display name of the payor.
class 
json 
Additional coverage classifications.  
Only plan and group will be visible in the Canvas UI.
Click to view child attributes
type 
json 
Type of class such as 'group' or 'plan'.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-class 
code 
string 
The code of the class.
**Value Options Supported:**
  - plan 
  - subplan 
  - group 
  - subgroup 
value 
string 
Value associated with the type, such as plan or group number.
name 
string 
Human readable description of the type and value, such as plan name or group name.
order 
number [ 1-5 ] 
The order in which coverages should be used when adjudicating claims.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Coverage/{id}
#### Coverage update
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the Coverage.
identifier 
array[json] required
An identifier for the insured of an insurance policy, usually assigned by the insurance carrier.
Click to view child attributes
type 
json required
Insurance member ID description
Click to view child attributes
system 
required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0203 
code 
required
The code of the insurance member ID description.
**Value Options Supported:**
  - MB 
display 
The display name of the coding.
value 
string required
Insurance member ID value
status 
enum [ active | cancelled ] required
The status of the Coverage.   
In Canvas, the status of `active` means it appears in the Patient's Profile page either under the main or other coverage sections, while a status of `cancelled` means it was removed and no longer appears on the page. An expired coverage will still show as `active`, so be sure to set/read the `period.end` attribute.
If a coverage in the Canvas UI is in the "Other coverages" section, on an update if the status stays `active`, it will remain in the "Other coverages" section.
type 
json 
Type of coverage, such as medical, workers compensation, self pay, etc.  
In order for this value to display on the Canvas UI, the coverage type needs to be configured for the specific payor via our insurer settings. To get to these settings, see this [Pylon article](https://help.canvasmedical.com/articles/5877696655-patient-coverages#managing-insurers-68).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-selfpay 
  - http://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string required
The code of the coverage type.
**Value Options Supported:**
  - pay 
  - ANNU 
  - AUTOPOL 
  - CHAR 
  - COL 
  - CRIME 
  - DENTAL 
  - DENTPRG 
  - DIS 
  - DISEASE 
  - DRUGPOL 
  - EAP 
  - EWB 
  - ENDRENAL 
  - EHCPOL 
  - FLEXP 
  - GOVEMP 
  - HIP 
  - HMO 
  - HSAPOL 
  - HIRISK 
  - HIVAIDS 
  - IND 
  - LIFE 
  - LTC 
  - MCPOL 
  - MANDPOL 
  - MENTPOL 
  - MENTPRG 
  - MILITARY 
  - POS 
  - PPO 
  - PNC 
  - DISEASEPRG 
  - PUBLICPOL 
  - REI 
  - RETIRE 
  - SAFNET 
  - SOCIAL 
  - SUBSIDIZ 
  - SUBSIDMC 
  - SUBSUPP 
  - SUBPOL 
  - SUBPRG 
  - SURPL 
  - TLIFE 
  - UMBRL 
  - UNINSMOT 
  - ULIFE 
  - VET 
  - VISPOL 
  - CANPRG 
  - WCBPOL 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Pay 
  - Annuity policy 
  - Automobile 
  - Charity program 
  - Collision coverage policy 
  - Crime victim program 
  - Dental care policy 
  - Dental program 
  - Disability insurance policy 
  - Disease specific policy 
  - Drug policy 
  - Employee assistance program 
  - Employee welfare benefit plan policy 
  - End renal program 
  - Extended healthcare 
  - Flexible benefit plan policy 
  - Government employee health program 
  - Health insurance plan policy 
  - Health maintenance organization policy 
  - Health spending account 
  - High risk pool program 
  - HIV-AIDS program 
  - Indigenous peoples health program 
  - Life insurance policy 
  - Long term care policy 
  - Managed care policy 
  - Mandatory health program 
  - Mental health policy 
  - Mental health program 
  - Military health program 
  - Point of service policy 
  - Preferred provider organization policy 
  - Property and casualty insurance policy 
  - Public health program 
  - Public healthcare 
  - Reinsurance policy 
  - Retiree health program 
  - Safety net clinic program 
  - Social service program 
  - Subsidized health program 
  - Subsidized managed care program 
  - Subsidized supplemental health program 
  - Substance use policy 
  - Substance use program 
  - Surplus line insurance policy 
  - Term life insurance policy 
  - Umbrella liability insurance policy 
  - Uninsured motorist policy 
  - Universal life insurance policy 
  - Veteran health program 
  - Vision care policy 
  - Women's cancer detection program 
  - Worker's compensation 
subscriber 
json required
Who was signed up for or 'owns' the Coverage.
Click to view child attributes
reference 
string required
The reference string of the patient subscriber in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
subscriberId 
string 
ID assigned to the subscriber
beneficiary 
json required
Who benefits from the coverage; the patient when products or services are provided.
Click to view child attributes
reference 
string required
The reference string of the patient beneficiary in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
relationship 
json required
The relationship of beneficiary (patient) to the subscriber.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/subscriber-relationship 
code 
string 
The code of the relationship.
**Value Options Supported:**
  - child 
  - spouse 
  - other 
  - self 
  - injured 
display 
string 
The display name of the coding.
period 
json 
If the start date is missing for a create/update interaction, it will be set to the current date of ingestion.
Click to view child attributes
start 
date 
Starting time with inclusive boundary
end 
date 
End time with inclusive boundary, if not ongoing.
payor 
array[json] required
Issuer of the policy.
Two methods for specifying this data are supported:
  - sending an [**Organization**](/api/organization) reference in `payor[0].reference`
        ```json
          "payor": [
             {
                 "reference": "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728",
                 "type": "Organization",
                 "display": "Medicare Advantage"
             }
           ],
        ```
  - sending a `payor[0].identifier.value` corresponding to the Coverage's payor id. For now, these values can only be found and updated in the [Insurers Admin view](https://canvas-medical.help.usepylon.com/articles/8126548200-managing-insurers) in Canvas. 
        ```json
          "payor": [
           {
             "identifier": {
               "system": "https://www.claim.md/services/era/",
               "value": "13162"
             },
             "display": "1199 National Benefit Fund"
           }
         ],
        ```
A `reference` or `identifier.value` is required in a Create/Update.
Click to view child attributes
reference 
string 
The Organization reference to the Coverage's payor in the format "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728"
type 
string 
Type the reference refers to (e.g. "Organization").
display 
string 
The display name of the payor.
identifier 
json 
Logical reference, when literal reference is not known.
Click to view child attributes
value 
string required
The value that is unique. These values can only be found and updated in the [Insurers Admin view](https://help.canvasmedical.com/articles/5877696655-patient-coverages#managing-insurers-68) in Canvas.
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - https://www.claim.md/services/era/ 
class 
json 
Additional coverage classifications.  
Only plan and group will be visible in the Canvas UI.
Click to view child attributes
type 
json required
Type of class such as 'group' or 'plan'.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-class 
code 
string required
The code of the class.
**Value Options Supported:**
  - plan 
  - subplan 
  - group 
  - subgroup 
value 
string 
Value associated with the type, such as plan or group number.
name 
string 
Human readable description of the type and value, such as plan name or group name.
order 
number [ 1-5 ] required
The order in which coverages should be used when adjudicating claims.
The order must between 1 and 5, inclusive.  
If multiple coverages for a patient are created with the same order number, the older one will be bumped down in rank, and the new one will take that rank.  
If this leads to multiple coverages being incremented to 5, the oldest (first to be inputted into Canvas) of the coverages at this rank will be displayed on the Canvas UI.
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Coverage
#### Coverage search
### Query Parameters
****
_id 
string 
The Canvas resource identifier of the Coverage.
patient 
string 
Retrieve coverages for a patient in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
identifier 
string 
Retrieve all coverages with a specific member ID
subscriberid 
string 
Retrieve all coverages with a specific subscriber ID
status 
string 
Retrieve coverages by a specific status.
**Search Values Supported:**
  - active
  - cancelled
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Coverage.
identifier 
array[json] 
An identifier for the insured of an insurance policy, usually assigned by the insurance carrier.
Click to view child attributes
type 
json 
Insurance member ID description
Click to view child attributes
system 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0203 
code 
The code of the insurance member ID description.
**Value Options Supported:**
  - MB 
display 
The display name of the coding.
value 
string 
Insurance member ID value
status 
enum [ active | cancelled ] 
The status of the Coverage.   
In Canvas, the status of `active` means it appears in the Patient's Profile page either under the main or other coverage sections, while a status of `cancelled` means it was removed and no longer appears on the page. An expired coverage will still show as `active`, so be sure to set/read the `period.end` attribute.
type 
json 
Type of coverage, such as medical, workers compensation, self pay, etc.  
In order for this value to display on the Canvas UI, the coverage type needs to be configured for the specific payor via our insurer settings. To get to these settings, see this [Pylon article](https://help.canvasmedical.com/articles/5877696655-patient-coverages#managing-insurers-68).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-selfpay 
  - http://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string 
The code of the coverage type.
**Value Options Supported:**
  - pay 
  - ANNU 
  - AUTOPOL 
  - CHAR 
  - COL 
  - CRIME 
  - DENTAL 
  - DENTPRG 
  - DIS 
  - DISEASE 
  - DRUGPOL 
  - EAP 
  - EWB 
  - ENDRENAL 
  - EHCPOL 
  - FLEXP 
  - GOVEMP 
  - HIP 
  - HMO 
  - HSAPOL 
  - HIRISK 
  - HIVAIDS 
  - IND 
  - LIFE 
  - LTC 
  - MCPOL 
  - MANDPOL 
  - MENTPOL 
  - MENTPRG 
  - MILITARY 
  - POS 
  - PPO 
  - PNC 
  - DISEASEPRG 
  - PUBLICPOL 
  - REI 
  - RETIRE 
  - SAFNET 
  - SOCIAL 
  - SUBSIDIZ 
  - SUBSIDMC 
  - SUBSUPP 
  - SUBPOL 
  - SUBPRG 
  - SURPL 
  - TLIFE 
  - UMBRL 
  - UNINSMOT 
  - ULIFE 
  - VET 
  - VISPOL 
  - CANPRG 
  - WCBPOL 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Pay 
  - Annuity policy 
  - Automobile 
  - Charity program 
  - Collision coverage policy 
  - Crime victim program 
  - Dental care policy 
  - Dental program 
  - Disability insurance policy 
  - Disease specific policy 
  - Drug policy 
  - Employee assistance program 
  - Employee welfare benefit plan policy 
  - End renal program 
  - Extended healthcare 
  - Flexible benefit plan policy 
  - Government employee health program 
  - Health insurance plan policy 
  - Health maintenance organization policy 
  - Health spending account 
  - High risk pool program 
  - HIV-AIDS program 
  - Indigenous peoples health program 
  - Life insurance policy 
  - Long term care policy 
  - Managed care policy 
  - Mandatory health program 
  - Mental health policy 
  - Mental health program 
  - Military health program 
  - Point of service policy 
  - Preferred provider organization policy 
  - Property and casualty insurance policy 
  - Public health program 
  - Public healthcare 
  - Reinsurance policy 
  - Retiree health program 
  - Safety net clinic program 
  - Social service program 
  - Subsidized health program 
  - Subsidized managed care program 
  - Subsidized supplemental health program 
  - Substance use policy 
  - Substance use program 
  - Surplus line insurance policy 
  - Term life insurance policy 
  - Umbrella liability insurance policy 
  - Uninsured motorist policy 
  - Universal life insurance policy 
  - Veteran health program 
  - Vision care policy 
  - Women's cancer detection program 
  - Worker's compensation 
text 
string 
Plain text representation of the coverage type.
subscriber 
json 
Who was signed up for or 'owns' the Coverage.
Click to view child attributes
reference 
string 
The reference string of the patient subscriber in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
subscriberId 
string 
ID assigned to the subscriber
beneficiary 
json 
Who benefits from the coverage; the patient when products or services are provided.
Click to view child attributes
reference 
string 
The reference string of the patient beneficiary in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
relationship 
json 
The relationship of beneficiary (patient) to the subscriber.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/subscriber-relationship 
code 
string 
The code of the relationship.
**Value Options Supported:**
  - child 
  - spouse 
  - other 
  - self 
  - injured 
  - parent 
  - common 
display 
string 
The display name of the coding.
text 
string 
The 2 character code that represents the patient relationship to the insured as defined by CMS.
**Value Options Supported:**
  - 18 (Self) 
  - 01 (Spouse) 
  - 19 (Natural Child, insured has financial responsibility) 
  - 43 (Natural Child, insured does not have financial responsibility), 
  - 17 (Step Child) 
  - 10 (Foster Child) 
  - 15 (Ward of the Court) 
  - 20 (Employee) 
  - 21 (Unknown) 
  - 22 (Handicapped Dependent) 
  - 39 (Organ donor) 
  - 40 (Cadaver donor) 
  - 05 (Grandchild) 
  - 07 (Niece/Nephew) 
  - 41 (Injured Plaintiff) 
  - 23 (Sponsored Dependent) 
  - 24 (Minor Dependent of a Minor Dependent) 
  - 32 (Mother) 
  - 33 (Father) 
  - 04 (Grandparent) 
  - 53 (Life Partner) 
  - 29 (Significant Other) 
  - G8 (Other) 
period 
json 
The period during which the Coverage is in force.  
A missing end date means the coverage continues to be in force.
Click to view child attributes
start 
date 
Starting time with inclusive boundary
end 
date 
End time with inclusive boundary, if not ongoing.
payor 
array[json] 
Issuer of the policy.
Click to view child attributes
reference 
string 
The Organization reference to the Coverage's payor in the format "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728"
type 
string 
Type the reference refers to (e.g. "Organization").
display 
string 
The display name of the payor.
class 
json 
Additional coverage classifications.  
Only plan and group will be visible in the Canvas UI.
Click to view child attributes
type 
json 
Type of class such as 'group' or 'plan'.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/coverage-class 
code 
string 
The code of the class.
**Value Options Supported:**
  - plan 
  - subplan 
  - group 
  - subgroup 
value 
string 
Value associated with the type, such as plan or group number.
name 
string 
Human readable description of the type and value, such as plan name or group name.
order 
number [ 1-5 ] 
The order in which coverages should be used when adjudicating claims.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Coverage' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
          "resourceType": "Coverage",
          "identifier": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "MB",
                    "display": "Member Number"
                  }
                ]
              },
              "value": "1234"
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "code": "MILITARY",
                "display": "military health program"
              }
            ]
          },
          "subscriber": {
            "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b34"
          },
          "subscriberId": "123",
          "beneficiary": {
            "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b3"
          },
          "relationship": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                "code": "self"
              }
            ]
          },
          "period": {
            "start": "2021-06-27",
            "end": "2023-06-27"
          },
          "payor": [
            {
              "reference": "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728",
              "type": "Organization",
              "display": "Medicare Advantage"
            }
          ],
          "class": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "plan"
                  }
                ]
              },
              "value": "Starfleet HMO",
              "name": "Starfleet HMO"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subplan"
                  }
                ]
              },
              "value": "Stars",
              "name": "Stars"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "group"
                  }
                ]
              },
              "value": "Captains Only",
              "name": "Captains Only"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subgroup"
                  }
                ]
              },
              "value": "Subgroup 2",
              "name": "Subgroup 2"
            }
          ],
          "order": 1
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Coverage"
        payload = {
          "resourceType": "Coverage",
          "identifier": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "MB",
                    "display": "Member Number"
                  }
                ]
              },
              "value": "1234"
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "code": "MILITARY",
                "display": "military health program"
              }
            ]
          },
          "subscriber": { "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b34" },
          "subscriberId": "123",
          "beneficiary": { "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b3" },
          "relationship": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                "code": "self"
              }
            ]
          },
          "period": {
            "start": "2021-06-27",
            "end": "2023-06-27"
          },
          "payor": [
            {
              "reference": "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728",
              "type": "Organization",
              "display": "Medicare Advantage"
            }
          ],
          "class": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "plan"
                  }
                ]
              },
              "value": "Starfleet HMO",
              "name": "Starfleet HMO"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subplan"
                  }
                ]
              },
              "value": "Stars",
              "name": "Stars"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "group"
                  }
                ]
              },
              "value": "Captains Only",
              "name": "Captains Only"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subgroup"
                  }
                ]
              },
              "value": "Subgroup 2",
              "name": "Subgroup 2"
            }
          ],
          "order": 1
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Coverage/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Coverage/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Coverage",
          "id": "a7c6af04-a22f-47bf-9cc8-d41158b2ad62",
          "identifier": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "MB",
                    "display": "Member Number"
                  }
                ]
              },
              "value": "12345"
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "code": "MILITARY",
                "display": "Military health program"
              }
            ]
          },
          "subscriber": {
            "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
            "type": "Patient"
          },
          "subscriberId": "1234",
          "beneficiary": {
            "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
            "type": "Patient"
          },
          "relationship": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                "code": "self",
                "display": "Self"
              }
            ],
            "text": "18"
          },
          "period": {
            "start": "2023-09-19"
          },
          "payor": [
            {
              "reference": "Organization/c152eeb7-f204-4e28-acb5-c7e85390b17e",
              "type": "Organization",
              "display": " Custody Medical Services Program"
            }
          ],
          "class": [
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code": "plan"
                    }
                  ]
                },
                "value": "Starfleet HMO",
                "name": "Starfleet HMO"
              },
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code": "subplan"
                    }
                  ]
                },
                "value": "Stars",
                "name": "Stars"
              },
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code": "group"
                    }
                  ]
                },
                "value": "Captains Only",
                "name": "Captains Only"
              },
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code": "subgroup"
                    }
                  ]
                },
                "value": "Subgroup 2",
                "name": "Subgroup 2"
              }
          ],
          "order": 1
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Coverage resource 'c152eeb7-f204-4e28-acb5-c7e85390b17e'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Coverage/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
          "resourceType": "Coverage",
          "identifier": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "MB",
                    "display": "Member Number"
                  }
                ]
              },
              "value": "1234"
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "code": "MILITARY",
                "display": "military health program"
              }
            ]
          },
          "subscriber": {
            "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b34"
          },
          "subscriberId": "123",
          "beneficiary": {
            "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b3"
          },
          "relationship": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                "code": "self"
              }
            ]
          },
          "period": {
            "start": "2021-06-27",
            "end": "2023-06-27"
          },
          "payor": [
            {
              "reference": "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728",
              "type": "Organization",
              "display": "Medicare Advantage"
            }
          ],
          "class": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "plan"
                  }
                ]
              },
              "value": "Starfleet HMO",
              "name": "Starfleet HMO"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subplan"
                  }
                ]
              },
              "value": "Stars",
              "name": "Stars"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "group"
                  }
                ]
              },
              "value": "Captains Only",
              "name": "Captains Only"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subgroup"
                  }
                ]
              },
              "value": "Subgroup 2",
              "name": "Subgroup 2"
            }
          ],
          "order": 1
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Coverage/<id>"
        payload = {
          "resourceType": "Coverage",
          "identifier": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                    "code": "MB",
                    "display": "Member Number"
                  }
                ]
              },
              "value": "1234"
            }
          ],
          "status": "active",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "code": "MILITARY",
                "display": "military health program"
              }
            ]
          },
          "subscriber": { "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b34" },
          "subscriberId": "123",
          "beneficiary": { "reference": "Patient/febae9dcb7cf4d88ba27cc552a3f96b3" },
          "relationship": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                "code": "self"
              }
            ]
          },
          "period": {
            "start": "2021-06-27",
            "end": "2023-06-27"
          },
          "payor": [
            {
              "reference": "Organization/6741b035-2846-45b3-b7a3-251f7b7fc728",
              "type": "Organization",
              "display": "Medicare Advantage"
            }
          ],
          "class": [
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "plan"
                  }
                ]
              },
              "value": "Starfleet HMO",
              "name": "Starfleet HMO"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subplan"
                  }
                ]
              },
              "value": "Stars",
              "name": "Stars"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "group"
                  }
                ]
              },
              "value": "Captains Only",
              "name": "Captains Only"
            },
            {
              "type": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                    "code": "subgroup"
                  }
                ]
              },
              "value": "Subgroup 2",
              "name": "Subgroup 2"
            }
          ],
          "order": 1
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Coverage resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Coverage?identifier=12345&patient=Patient/b3084f7e884e4af2b7e23b1dca494abd' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Coverage?identifier=12345&patient=Patient/b3084f7e884e4af2b7e23b1dca494abd"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Bundle",
          "type": "searchset",
          "total": 2,
          "link": [
            {
                "relation": "self",
                "url": "/Coverage?identifier=12345&patient=Patient%2Fb3084f7e884e4af2b7e23b1dca494abd&_count=10&_offset=0"
            },
            {
                "relation": "first",
                "url": "/Coverage?identifier=12345&patient=Patient%2Fb3084f7e884e4af2b7e23b1dca494abd&_count=10&_offset=0"
            },
            {
                "relation": "last",
                "url": "/Coverage?identifier=12345&patient=Patient%2Fb3084f7e884e4af2b7e23b1dca494abd&_count=10&_offset=0"
            }
          ],
          "entry": [
            {
              "resource": {
                "resourceType": "Coverage",
                "id": "171a7243-f568-48cb-8052-3f2990dac1cd",
                "identifier": [
                  {
                    "type": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                          "code": "MB",
                          "display": "Member Number"
                        }
                      ]
                    },
                    "value": "11111"
                  }
                ],
                "status": "cancelled",
                "subscriber": {
                    "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
                    "type": "Patient"
                },
                "subscriberId": "1111",
                "beneficiary": {
                    "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
                    "type": "Patient"
                },
                "relationship": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                      "code": "self",
                      "display": "Self"
                    }
                  ],
                  "text": "18"
                },
                "period": {
                    "start": "2022-01-01"
                },
                "payor": [
                  {
                    "reference": "Organization/9b6709aa-a84e-4070-9a83-7c14dc31a511",
                    "type": "Organization",
                    "display": "AL BCBS"
                  }
                ],
                "order": 2
              }
            },
            {
              "resource": {
                "resourceType": "Coverage",
                "id": "27f42512-23e6-4c17-8569-80e14792b6f8",
                "identifier": [
                  {
                    "type": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                          "code": "MB",
                          "display": "Member Number"
                        }
                      ]
                    },
                    "value": "A1"
                  }
                ],
                "status": "cancelled",
                "subscriber": {
                    "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
                    "type": "Patient"
                },
                "subscriberId": "A",
                "beneficiary": {
                    "reference": "Patient/b3084f7e884e4af2b7e23b1dca494abd",
                    "type": "Patient"
                },
                "relationship": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
                      "code": "self",
                      "display": "Self"
                    }
                  ],
                  "text": "18"
                },
                "period": {
                    "start": "2022-05-31"
                },
                "payor": [
                  {
                    "reference": "Organization/02211bf5-9ee1-47d1-a1bc-e06bd848e5f3",
                    "type": "Organization",
                    "display": "Kevin Carey Insurance, Inc."
                  }
                ],
                "order": 1
              }
            }
          ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/coverage/


----- BEGIN PAGE https://docs.canvasmedical.com/api/coverageeligibilityrequest/
### 
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force.  
<https://hl7.org/fhir/R4/coverageeligibilityrequest.html>
### Endpoints
post /CoverageEligibilityRequest
post
/CoverageEligibilityRequest
#### CoverageEligibilityRequest create
If Claim.MD is set up in your Canvas instance, a creation of a coverage CoverageEligibilityRequest will kick off a request to Claim.MD to fetch the eligibility information. Use the returned `id` in the response.headers['location'] attribute to perform a [CoverageEligibilityResponse Search](/api/coverageeligibilityresponse/#search) to see what response Claim.MD returned.
### Attributes
resourceType 
string 
The FHIR Resource name.
status 
string required
Describes the state the request is in.
**Value Options Supported:**
  - active 
purpose 
array[string] required
What information is being requested.  
Supported values: only **["benefits"]** is valid
patient 
json required
Canvas patient resource whom the CoverageEligibilityRequest is for.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
date required
Creation date, required by the FHIR specification, but unused by Canvas as it will be defaulted to the Canvas ingestion timestamp.  
Canvas recommends sending the current datetime in ISO 8601 format.
insurer 
json required
Coverage issuer, required by the FHIR schema but unused by Canvas because we inherit the issuer directly from the Coverage resource provided.  
Canvas recommends setting `insurer` to `{}`.
insurance 
array[json] required
Patient insurance information.  
Canvas requires a single coverage resource identifying the insurance to check eligibility against.
Click to view child attributes
coverage 
json required
Insurance information.
Click to view child attributes
reference 
string required
The reference string of the coverage in the format of `"Coverage/f7663d7b-13bd-4236-843e-086306aea125"`.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/CoverageEligibilityRequest' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "CoverageEligibilityRequest",
            "status": "active",
            "purpose": [
                "benefits"
            ],
            "patient": {
                "reference": "Patient/9713f5a3c8464a2587912e80bc2dd938"
            },
            "created": "2023-09-19",
            "insurer": {},
            "insurance": [
                {
                    "focal": true,
                    "coverage": {
                        "reference": "Coverage/743aa331-2f85-420b-ab10-8a6b7bb6a1cf"
                    }
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CoverageEligibilityRequest"
        payload = {
            "resourceType": "CoverageEligibilityRequest",
            "status": "active",
            "purpose": [
                "benefits"
            ],
            "patient": {
                "reference": "Patient/9713f5a3c8464a2587912e80bc2dd938"
            },
            "created": "2023-09-19",
            "insurer": {},
            "insurance": [
                {
                    "focal": True,
                    "coverage": {
                        "reference": "Coverage/743aa331-2f85-420b-ab10-8a6b7bb6a1cf"
                    }
                }
            ]
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/coverageeligibilityrequest/


----- BEGIN PAGE https://docs.canvasmedical.com/api/coverageeligibilityresponse/
### 
The CoverageEligibilityResponse resource provides eligibility and plan details from processing a CoverageEligibilityRequest resource. It combines key information from a payor as to whether a Coverage is in-force, and optionally the nature of the Policy benefit details as well as the ability for the insurer to indicate whether the insurance provides benefits for requested types of services or requires preauthorization and if so what supporting information may be required.  
<https://hl7.org/fhir/R4/coverageeligibilityresponse.html>
### Endpoints
get /CoverageEligibilityResponse/{id} get /CoverageEligibilityResponse
get
/CoverageEligibilityResponse/{id}
#### CoverageEligibilityResponse read
### Path Parameters
id required
string 
The unique identifier for the CoverageEligibilityResponse   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the CoverageEligibilityResponse.
status 
string 
Status of the resource. The value is "entered-in-error" if the call to the third-party eligibility service failed.
**Value Options Supported:**
  - active 
  - draft 
  - entered-in-error 
purpose 
array[string] 
Reason for the request, will always be **["benefits"]**
patient 
json 
Patient resource the CoverageEligibilityResponse is for.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime 
Response creation date.
request 
json 
CoverageEligibilityRequest reference the elibibility response is for.
Click to view child attributes
reference 
string 
The reference string of the request in the format of `"CoverageEligibilityRequest/cd98975b-6cd4-413d-ab65-1fc5eec76762"`.
type 
string 
Type the reference refers to (e.g. "CoverageEligibilityRequest").
outcome 
string 
Outcome of the request processing, if an error occurs it will be marked as **"error"** othervise it will be marked as **"complete"**.
**Value Options Supported:**
  - error 
  - complete 
insurer 
json 
Coverage issuer.
Click to view child attributes
string 
Payor ID for the Coverage issuer.
string 
Text alternative for the resource.
insurance 
array[json] 
Patient insurance information. This includes the **Coverage** reference, extension for plan name and an array of items containing benefits and authorization details returned from Claim.MD.  
The amount of information surfaced here depends on the what the payor supports. Our clearinghouse (Claim.md) performs these eligibility checks, but not all coverages will support real-time eligibility checks. For more information on coverages within Canvas, see this [article](https://canvas-medical.help.usepylon.com/articles/5877696655-patient-coverages).
Click to view child attributes
coverage 
json 
Insurance information.
Click to view child attributes
reference 
string 
The reference string of the coverage in the format of `"Coverage/4a86f580-e192-489a-a9f0-7c915fc67111"`.
type 
string 
Type the reference refers to (e.g. "Coverage").
extension 
array[json] 
Canvas supports a plan name extension on this resource for read and search interactions.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/active-health-benefit-plan-coverage-description 
valueString 
string 
The plan name of the insurance.
item 
array[json] 
Array of items containing benefits and authorization details.
Click to view child attributes
name 
string 
Short name for the benefit
unit 
json 
Individual or family.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/benefit-unit 
code 
string 
The code of the benefit unit.
**Value Options Supported:**
  - individual 
  - family 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Individual 
  - Family 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Individual 
  - Family 
network 
json 
In or out of network.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/benefit-network 
code 
string 
The code of the benefit network.
**Value Options Supported:**
  - in 
  - out 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - In Network 
  - Out of Network 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - In Network 
  - Out of Network 
benefit 
array[json] 
Benefit Summary.
Click to view child attributes
type 
json 
Benefit classification.
Click to view child attributes
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Co-Insurance 
  - Co-Payment 
  - Active Coverage 
  - Deductible 
  - Out of Pocket (Stop Loss) 
  - Limitations 
  - Contact following entity for eligibility or benefit information 
  - (Incomplete information) 
allowedString 
string 
Benefits allowed.   
Used for Co-Insurance benefit types.
allowedMoney 
json 
Benefits allowed.   
Used for Co-Payment, Deductible, or Out of Pocket benefit types.
Click to view child attributes
value 
decimal 
Numerical value (with implicit precision)
allowedUnsignedInt 
unsignedInt 
Benefits allowed.   
Used for Limitations benefit types.
usedMoney 
json 
Benefits used.   
Used for Deductible or Out of Pocket benefit types.
Click to view child attributes
value 
decimal 
Numerical value (with implicit precision)
usedUnsignedInt 
unsignedInt 
Benefits used.   
Used for Limitations benefit types.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/CoverageEligibilityResponse
#### CoverageEligibilityResponse search
### Query Parameters
****
_id 
string 
The Canvas resource identifier of the CoverageEligibilityResponse.
patient 
string 
The patient reference associated with the CoverageEligibilityResponse in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
request 
string 
The coverage eligibility request reference associated with the CoverageEligibilityResponse in the format `"CoverageEligibilityRequest/cd98975b-6cd4-413d-ab65-1fc5eec76762"`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the CoverageEligibilityResponse.
status 
string 
Status of the resource. The value is "entered-in-error" if the call to the third-party eligibility service failed.
**Value Options Supported:**
  - active 
  - draft 
  - entered-in-error 
purpose 
array[string] 
Reason for the request, will always be **["benefits"]**
patient 
json 
Patient resource the CoverageEligibilityResponse is for.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime 
Response creation date.
request 
json 
CoverageEligibilityRequest reference the elibibility response is for.
Click to view child attributes
reference 
string 
The reference string of the request in the format of `"CoverageEligibilityRequest/cd98975b-6cd4-413d-ab65-1fc5eec76762"`.
type 
string 
Type the reference refers to (e.g. "CoverageEligibilityRequest").
outcome 
string 
Outcome of the request processing, if an error occurs it will be marked as **"error"** othervise it will be marked as **"complete"**.
**Value Options Supported:**
  - error 
  - complete 
insurer 
json 
Coverage issuer.
Click to view child attributes
string 
Payor ID for the Coverage issuer.
string 
Text alternative for the resource.
insurance 
array[json] 
Patient insurance information. This includes the **Coverage** reference, extension for plan name and an array of items containing benefits and authorization details returned from Claim.MD.  
The amount of information surfaced here depends on the what the payor supports. Our clearinghouse (Claim.md) performs these eligibility checks, but not all coverages will support real-time eligibility checks. For more information on coverages within Canvas, see this [article](https://canvas-medical.help.usepylon.com/articles/5877696655-patient-coverages).
Click to view child attributes
coverage 
json 
Insurance information.
Click to view child attributes
reference 
string 
The reference string of the coverage in the format of `"Coverage/4a86f580-e192-489a-a9f0-7c915fc67111"`.
type 
string 
Type the reference refers to (e.g. "Coverage").
extension 
array[json] 
Canvas supports a plan name extension on this resource for read and search interactions.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/active-health-benefit-plan-coverage-description 
valueString 
string 
The plan name of the insurance.
item 
array[json] 
Array of items containing benefits and authorization details.
Click to view child attributes
name 
string 
Short name for the benefit
unit 
json 
Individual or family.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/benefit-unit 
code 
string 
The code of the benefit unit.
**Value Options Supported:**
  - individual 
  - family 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Individual 
  - Family 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Individual 
  - Family 
network 
json 
In or out of network.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/benefit-network 
code 
string 
The code of the benefit network.
**Value Options Supported:**
  - in 
  - out 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - In Network 
  - Out of Network 
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - In Network 
  - Out of Network 
benefit 
array[json] 
Benefit Summary.
Click to view child attributes
type 
json 
Benefit classification.
Click to view child attributes
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - Co-Insurance 
  - Co-Payment 
  - Active Coverage 
  - Deductible 
  - Out of Pocket (Stop Loss) 
  - Limitations 
  - Contact following entity for eligibility or benefit information 
  - (Incomplete information) 
allowedString 
string 
Benefits allowed.   
Used for Co-Insurance benefit types.
allowedMoney 
json 
Benefits allowed.   
Used for Co-Payment, Deductible, or Out of Pocket benefit types.
Click to view child attributes
value 
decimal 
Numerical value (with implicit precision)
allowedUnsignedInt 
unsignedInt 
Benefits allowed.   
Used for Limitations benefit types.
usedMoney 
json 
Benefits used.   
Used for Deductible or Out of Pocket benefit types.
Click to view child attributes
value 
decimal 
Numerical value (with implicit precision)
usedUnsignedInt 
unsignedInt 
Benefits used.   
Used for Limitations benefit types.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/CoverageEligibilityResponse/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CoverageEligibilityResponse/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "CoverageEligibilityResponse",
          "id": "9ad12f4e-4f35-4f54-8b4f-036516488191",
          "status": "active",
          "purpose": [
              "benefits"
          ],
          "patient": {
              "reference": "Patient/b41c7cda738d440cb55e0e6cb67499a1",
              "type": "Patient"
          },
          "created": "2023-09-19T18:16:39.551617+00:00",
          "request": {
              "reference": "CoverageEligibilityRequest/d7254641-e363-488c-91fa-b93a6170b9e0",
              "type": "CoverageEligibilityRequest"
          },
          "outcome": "complete",
          "insurer": {
              "identifier": "1111",
              "display": "Payer ID: 1111"
          },
          "insurance": [
            {
              "extension": [
                {
                  "url": "http://schemas.canvasmedical.com/fhir/extensions/active-health-benefit-plan-coverage-description",
                  "valueString": "Humana Gold Plus"
                }
              ],
              "coverage": {
                  "reference": "Coverage/4a86f580-e192-489a-a9f0-7c915fc67111",
                  "type": "Coverage"
              },
              "item": [
                {
                  "network": {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                        "code": "in",
                        "display": "In Network"
                      }
                    ],
                    "text": "In Network"
                  },
                  "unit": {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                        "code": "individual",
                        "display": "Individual"
                      }
                    ],
                    "text": "Individual"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Co-Payment"
                      },
                      "allowedMoney": {
                          "value": 333
                      }
                    },
                    {
                      "type": {
                          "text": "Co-Insurance"
                      },
                      "allowedString": "0.0%"
                    }
                  ]
                },
                {
                  "network": {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                        "code": "in",
                        "display": "In Network"
                      }
                    ],
                    "text": "In Network"
                  },
                  "unit": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                          "code": "individual",
                          "display": "Individual"
                        }
                      ],
                      "text": "Individual"
                  },
                    "benefit": [
                      {
                        "type": {
                            "text": "Co-Insurance"
                        },
                        "allowedString": "0.0%"
                      },
                      {
                        "type": {
                            "text": "Co-Insurance"
                        },
                        "allowedString": "0.0%"
                      },
                      {
                        "type": {
                            "text": "Co-Insurance"
                        },
                        "allowedString": "0.0%"
                      }
                    ]
                },
                {
                  "benefit": [
                    {
                      "type": {
                          "text": "Benefit Description (Incomplete information)"
                      }
                    }
                  ]
                },
                {
                  "benefit": [
                    {
                      "type": {
                          "text": "Active Coverage"
                      }
                    }
                  ]
                },
                {
                  "network": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                          "code": "in",
                          "display": "In Network"
                        }
                      ],
                      "text": "In Network"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Active Coverage"
                      }
                    },
                    {
                      "type": {
                          "text": "Primary Care Provider (Incomplete information)"
                      }
                    },
                    {
                      "type": {
                          "text": "Benefit Description (Incomplete information)"
                      }
                    },
                    {
                      "type": {
                          "text": "Benefit Disclaimer (Incomplete information)"
                      }
                    }
                  ]
                },
                {
                  "name": "Dental Care",
                  "network": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                          "code": "in",
                          "display": "In Network"
                        }
                      ],
                      "text": "In Network"
                  },
                  "unit": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                          "code": "individual",
                          "display": "Individual"
                        }
                      ],
                      "text": "Individual"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Active Coverage"
                      }
                    }
                  ]
                },
                {
                  "name": "Health Benefit Plan Coverage",
                  "network": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                          "code": "in",
                          "display": "In Network"
                        }
                      ],
                      "text": "In Network"
                  },
                  "unit": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                          "code": "individual",
                          "display": "Individual"
                        }
                      ],
                      "text": "Individual"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Deductible (Incomplete information)"
                      }
                    },
                    {
                      "type": {
                          "text": "Deductible"
                      },
                      "allowedMoney": {
                          "value": 6900
                      },
                      "usedMoney": {
                          "value": 0.0
                      }
                    },
                    {
                      "type": {
                          "text": "Active Coverage"
                      }
                    },
                    {
                      "type": {
                          "text": "Out of Pocket (Stop Loss)"
                      },
                      "allowedMoney": {
                          "value": 6900
                      },
                      "usedMoney": {
                          "value": 0.0
                      }
                    },
                    {
                      "type": {
                          "text": "Out of Pocket (Stop Loss)"
                      },
                      "allowedMoney": {
                          "value": 6900
                      },
                      "usedMoney": {
                          "value": 0.0
                      }
                    }
                  ]
                },
                {
                  "name": "Health Benefit Plan Coverage",
                  "network": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                          "code": "in",
                          "display": "In Network"
                        }
                      ],
                      "text": "In Network"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Benefit Description (Incomplete information)"
                      }
                    }
                  ]
                },
                {
                  "name": "Physician Visit - Well",
                  "network": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                          "code": "in",
                          "display": "In Network"
                        }
                      ],
                      "text": "In Network"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Non-Covered (Incomplete information)"
                      }
                    }
                  ]
                },
                {
                  "name": "Professional (Physician) Visit - Office",
                  "network": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                          "code": "in",
                          "display": "In Network"
                        }
                      ],
                      "text": "In Network"
                  },
                  "unit": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                          "code": "individual",
                          "display": "Individual"
                        }
                      ],
                      "text": "Individual"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Co-Insurance"
                      },
                      "allowedString": "0.0%"
                    }
                  ]
                },
                {
                  "name": "Professional (Physician) Visit - Office",
                  "network": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                          "code": "in",
                          "display": "In Network"
                        }
                      ],
                      "text": "In Network"
                  },
                  "benefit": [
                    {
                      "type": {
                          "text": "Non-Covered (Incomplete information)"
                      }
                    },
                    {
                      "type": {
                          "text": "Active Coverage"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown CoverageEligibilityResponse resource 'c152eeb7-f204-4e28-acb5-c7e85390b17e'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/CoverageEligibilityResponse?request=CoverageEligibilityRequest/b41c7cda738d440cb55e0e6cb67499a1' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/CoverageEligibilityResponse?request=CoverageEligibilityRequest/b41c7cda738d440cb55e0e6cb67499a1"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Bundle",
          "type": "searchset",
          "total": 1,
          "entry": [
            {
              "resource": {
                "resourceType": "CoverageEligibilityResponse",
                "id": "9ad12f4e-4f35-4f54-8b4f-036516488191",
                "status": "active",
                "purpose": [
                    "benefits"
                ],
                "patient": {
                    "reference": "Patient/b41c7cda738d440cb55e0e6cb67499a1",
                    "type": "Patient"
                },
                "created": "2023-09-19T18:16:39.551617+00:00",
                "request": {
                    "reference": "CoverageEligibilityRequest/d7254641-e363-488c-91fa-b93a6170b9e0",
                    "type": "CoverageEligibilityRequest"
                },
                "outcome": "complete",
                "insurer": {
                    "identifier": "1111",
                    "display": "Payer ID: 1111"
                },
                "insurance": [
                  {
                    "extension": [
                      {
                        "url": "http://schemas.canvasmedical.com/fhir/extensions/active-health-benefit-plan-coverage-description",
                        "valueString": "Humana Gold Plus"
                      }
                    ],
                    "coverage": {
                        "reference": "Coverage/4a86f580-e192-489a-a9f0-7c915fc67111",
                        "type": "Coverage"
                    },
                    "item": [
                      {
                        "network": {
                          "coding": [
                            {
                              "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                              "code": "in",
                              "display": "In Network"
                            }
                          ],
                          "text": "In Network"
                        },
                        "unit": {
                          "coding": [
                            {
                              "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                              "code": "individual",
                              "display": "Individual"
                            }
                          ],
                          "text": "Individual"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Co-Payment"
                            },
                            "allowedMoney": {
                                "value": 333
                            }
                          },
                          {
                            "type": {
                                "text": "Co-Insurance"
                            },
                            "allowedString": "0.0%"
                          }
                        ]
                      },
                      {
                        "network": {
                          "coding": [
                            {
                              "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                              "code": "in",
                              "display": "In Network"
                            }
                          ],
                          "text": "In Network"
                        },
                        "unit": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                                "code": "individual",
                                "display": "Individual"
                              }
                            ],
                            "text": "Individual"
                        },
                          "benefit": [
                            {
                              "type": {
                                  "text": "Co-Insurance"
                              },
                              "allowedString": "0.0%"
                            },
                            {
                              "type": {
                                  "text": "Co-Insurance"
                              },
                              "allowedString": "0.0%"
                            },
                            {
                              "type": {
                                  "text": "Co-Insurance"
                              },
                              "allowedString": "0.0%"
                            }
                          ]
                      },
                      {
                        "benefit": [
                          {
                            "type": {
                                "text": "Benefit Description (Incomplete information)"
                            }
                          }
                        ]
                      },
                      {
                        "benefit": [
                          {
                            "type": {
                                "text": "Active Coverage"
                            }
                          }
                        ]
                      },
                      {
                        "network": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                                "code": "in",
                                "display": "In Network"
                              }
                            ],
                            "text": "In Network"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Active Coverage"
                            }
                          },
                          {
                            "type": {
                                "text": "Primary Care Provider (Incomplete information)"
                            }
                          },
                          {
                            "type": {
                                "text": "Benefit Description (Incomplete information)"
                            }
                          },
                          {
                            "type": {
                                "text": "Benefit Disclaimer (Incomplete information)"
                            }
                          }
                        ]
                      },
                      {
                        "name": "Dental Care",
                        "network": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                                "code": "in",
                                "display": "In Network"
                              }
                            ],
                            "text": "In Network"
                        },
                        "unit": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                                "code": "individual",
                                "display": "Individual"
                              }
                            ],
                            "text": "Individual"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Active Coverage"
                            }
                          }
                        ]
                      },
                      {
                        "name": "Health Benefit Plan Coverage",
                        "network": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                                "code": "in",
                                "display": "In Network"
                              }
                            ],
                            "text": "In Network"
                        },
                        "unit": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                                "code": "individual",
                                "display": "Individual"
                              }
                            ],
                            "text": "Individual"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Deductible (Incomplete information)"
                            }
                          },
                          {
                            "type": {
                                "text": "Deductible"
                            },
                            "allowedMoney": {
                                "value": 6900
                            },
                            "usedMoney": {
                                "value": 0.0
                            }
                          },
                          {
                            "type": {
                                "text": "Active Coverage"
                            }
                          },
                          {
                            "type": {
                                "text": "Out of Pocket (Stop Loss)"
                            },
                            "allowedMoney": {
                                "value": 6900
                            },
                            "usedMoney": {
                                "value": 0.0
                            }
                          },
                          {
                            "type": {
                                "text": "Out of Pocket (Stop Loss)"
                            },
                            "allowedMoney": {
                                "value": 6900
                            },
                            "usedMoney": {
                                "value": 0.0
                            }
                          }
                        ]
                      },
                      {
                        "name": "Health Benefit Plan Coverage",
                        "network": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                                "code": "in",
                                "display": "In Network"
                              }
                            ],
                            "text": "In Network"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Benefit Description (Incomplete information)"
                            }
                          }
                        ]
                      },
                      {
                        "name": "Physician Visit - Well",
                        "network": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                                "code": "in",
                                "display": "In Network"
                              }
                            ],
                            "text": "In Network"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Non-Covered (Incomplete information)"
                            }
                          }
                        ]
                      },
                      {
                        "name": "Professional (Physician) Visit - Office",
                        "network": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                                "code": "in",
                                "display": "In Network"
                              }
                            ],
                            "text": "In Network"
                        },
                        "unit": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-unit",
                                "code": "individual",
                                "display": "Individual"
                              }
                            ],
                            "text": "Individual"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Co-Insurance"
                            },
                            "allowedString": "0.0%"
                          }
                        ]
                      },
                      {
                        "name": "Professional (Physician) Visit - Office",
                        "network": {
                            "coding": [
                              {
                                "system": "http://terminology.hl7.org/CodeSystem/benefit-network",
                                "code": "in",
                                "display": "In Network"
                              }
                            ],
                            "text": "In Network"
                        },
                        "benefit": [
                          {
                            "type": {
                                "text": "Non-Covered (Incomplete information)"
                            }
                          },
                          {
                            "type": {
                                "text": "Active Coverage"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "id": "101",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/coverageeligibilityresponse/


----- BEGIN PAGE https://docs.canvasmedical.com/api/customer-authentication/
##  Introduction 
  - Canvas is an OAuth 2.0 authorization server.
  - This page contains information about how you can create third-party applications within your Canvas EHR instance and use those applications to access the FHIR API.
  - Canvas supports most OAuth flows, but this document will focus on two of the most used: 
    - **Client Credentials** : Mostly used for Machine-to-Machine authentication (e.g., CLIs, Daemons).
    - **Authorization Code** : Usually used for web/native applications since it requires a user to log in to the system.
##  Registering a third-party application on Canvas 
  - Registering a third-party application is always the first step.
  - In order to do so, you'll need to: 
    1. Go to `{YOUR_CANVAS_EHR_INSTANCE}/auth/applications/` where you'll see the following page: ![Authorization Page](/assets/images/ed67823-Screenshot_2021-10-26_at_16.22.31.png)
    2. Once you click the link on that page, you'll see the following: ![Application Registration](/assets/images/8b49344-Screenshot_2021-10-26_at_16.24.01.png)
    - You'll need to set a name for the app, set the `Client type` to `Confidential`, choose one of the `Authorization grant types`, and set the `Redirect URIs` if needed. Leave the `Algorithm` at `No OIDC support` for now.
    - Here's how it should look if you created a new "Test Application" with the `client-credentials` grant type: ![Application Example](/assets/images/6190a01-Screenshot_2021-10-26_at_16.26.59.png)
    - That's it. Take note of your `Client ID` and `Client Secret`, and proceed to the section related to the `Authorization Grant Type` you chose.
##  Client Credentials 
  - The Client Credentials flow assumes that everyone involved is capable of securely storing the `Client ID` and `Client Secret`.
  - In order to get a token, you just need to:
    ```shell
    curl --request POST '{YOUR_CANVAS_EHR_INSTANCE}/auth/token/' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'grant_type=client_credentials' \
    --data-urlencode 'client_id={YOUR_CLIENT_ID}' \
    --data-urlencode 'client_secret={YOUR_CLIENT_SECRET}'
    ```
and you'll get back a JSON which will contain an `access_token` that'll be valid for 10 hours.
##  Authorization Code 
The Authorization Code flow ensures a user of the Canvas EHR explicitly approves the token request. It's typically used by web/mobile applications that act on behalf of a specific user (staff or patient).
The access token obtained through this flow carries the identity of the user who authorized it. This means:
  - **FHIR API calls** are scoped to that user's permissions.
  - **SimpleAPI plugin endpoints** receive the user as the [event actor](/sdk/events/#event-actor), allowing plugins to identify which user is making the request and enforce access controls.
###  Basic Steps 
  1. The application opens a browser to the Canvas authorization endpoint.
  2. The logged-in user sees the authorization prompt and approves the request.
  3. The user is redirected back to the `redirect_uri` with an authorization code in the query string.
  4. The application exchanges the authorization code for an access token and refresh token.
###  Step 1: Redirect the User to Authorize 
Open the following URL in the user's browser:
    ```text
    {YOUR_CANVAS_EHR_INSTANCE}/auth/authorize/?response_type=code&client_id={CLIENT_ID}&scope={SCOPES}&redirect_uri={REDIRECT_URI}&launch={LAUNCH_CONTEXT}
    ```
**Important notes:**
  - **`launch` parameter (required for staff users):** Staff users must include a `launch` parameter containing a base64-encoded JSON object with context. Without this parameter, the authorization will be denied with `error=access_denied`.
        ```bash
        # Encode a launch context with a patient id
        echo -n '{"patient":"PATIENT_KEY_HERE"}' | base64
        # Result: eyJwYXRpZW50IjoiUEFUSUVOVF9LRVlfSEVSRSJ9
        # Or with an empty patient (if no specific patient context is needed)
        echo -n '{"patient":""}' | base64
        # Result: eyJwYXRpZW50IjoiIn0=
        ```
  - **URL-encode special characters in scopes:** Scopes like `user/*.read` contain `/` which must be encoded as `%2F` in the URL. For example: `scope=user%2F*.read%20user%2F*.write`
  - **Authorization codes expire quickly:** The code returned in the redirect is valid for approximately 60 seconds. Exchange it for tokens immediately.
**Example authorize URL:**
    ```text
    {YOUR_CANVAS_EHR_INSTANCE}/auth/authorize/?response_type=code&client_id={CLIENT_ID}&scope=user%2F*.read%20user%2F*.write&redirect_uri=https://your-app.com/callback&launch=eyJwYXRpZW50IjoiIn0=
    ```
After the user clicks **Authorize** , they are redirected to your `redirect_uri` with a `code` parameter:
    ```text
    https://your-app.com/callback?code=AUTHORIZATION_CODE
    ```
###  Step 2: Exchange the Code for Tokens 
    ```shell
    curl --request POST '{YOUR_CANVAS_EHR_INSTANCE}/auth/token/' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'grant_type=authorization_code' \
    --data-urlencode 'client_id={CLIENT_ID}' \
    --data-urlencode 'client_secret={CLIENT_SECRET}' \
    --data-urlencode 'redirect_uri={REDIRECT_URI}' \
    --data-urlencode 'code={CODE_FROM_PREVIOUS_STEP}'
    ```
**Response:**
    ```json
    {
      "access_token": "AN_ACCESS_TOKEN",
      "expires_in": 36000,
      "token_type": "Bearer",
      "scope": "user/*.read user/*.write",
      "refresh_token": "A_REFRESH_TOKEN",
      "patient": ""
    }
    ```
  - **`access_token`** : Valid for 10 hours (36000 seconds). Use this as a `Bearer` token in API requests.
  - **`refresh_token`** : Non-expiring but **single-use**. Each time you refresh, you receive a new refresh token — store it to maintain long-term access.
###  Step 3: Use the Token 
Use the access token as a Bearer token in the `Authorization` header:
    ```shell
    # FHIR API example
    curl --request GET '{FUMAGE_BASE_URL}/Patient' \
    --header 'Authorization: Bearer {ACCESS_TOKEN}'
    # SimpleAPI plugin endpoint example
    curl --request GET '{YOUR_CANVAS_EHR_INSTANCE}/plugin-io/api/{plugin_name}/{endpoint}' \
    --header 'Authorization: Bearer {ACCESS_TOKEN}'
    ```
When a SimpleAPI plugin receives a request with a Bearer token, Canvas validates the token, identifies the user, and sets them as the [event actor](/sdk/events/#event-actor). The plugin can then use `self.event.actor` to determine which user is making the request.
###  Step 4: Refresh the Token 
Access tokens expire after 10 hours. Use the refresh token to get a new access token without requiring the user to re-authorize:
    ```shell
    curl --request POST '{YOUR_CANVAS_EHR_INSTANCE}/auth/token/' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'grant_type=refresh_token' \
    --data-urlencode 'client_id={CLIENT_ID}' \
    --data-urlencode 'client_secret={CLIENT_SECRET}' \
    --data-urlencode 'refresh_token={REFRESH_TOKEN}' \
    --data-urlencode 'scope={SCOPES}'
    ```
**Note:** The `scope` parameter must match the scopes from the original authorization (or be a subset). If omitted, Canvas will attempt to use the application's default allowed scopes, but this may fail with `invalid_scope` if the defaults don't match the original grant.
This returns a new `access_token` and a **new** `refresh_token`. The previous refresh token is consumed and cannot be reused. Store the new refresh token for the next refresh cycle.
###  Recommended Pattern for External Applications 
For applications that need to make API calls on behalf of specific Canvas users (e.g., a provider portal calling plugin endpoints):
  1. **One-time setup per user:** Each user authorizes the app via the browser flow. Store the refresh token per user in your backend.
  2. **Ongoing access:** Before making API calls, check if the access token is still valid. If expired, use the stored refresh token to get a new one.
  3. **Token storage:** Access tokens last 10 hours. Refresh tokens are non-expiring but single-use — always store the latest one returned from a refresh.
##  Patient Scoped Tokens 
Canvas supports patient scoped tokens. These are access tokens requested on behalf of a specific patient and have read/write access to that patient's records only.
To acquire a patient scoped token, you will need to include some parameters in the body of your token request:
  - A `client_id` and `client_secret` that your application will use to authenticate with Canvas.
  - The Canvas resource id for the `patient` the token will be scoped to
  - A `scope` parameter with space separated patient level scopes requested for the token. 
    - Additional requested scopes should follow the pattern `patient/<ResourceName>.<read/write/*>`
      - `patient/Appointment.*`
      - `patient/Appointment.read patient/Appointment.write`
      - `patient/Patient.read`
      - `patient/Practitioner.read`
    - Canvas provides support for the wildcard character, but highly recommends only requesting the minimal scopes and access needed and using it as a convenience when both read and write are truly required for the application.
See Resources by context for the full list of resources a `patient/` scope can read and write.
###  Example curl request 
    ```bash
    curl --location --request POST \
          'https://<your_subdomain_here>.canvasmedical.com/auth/token/' \
          --header 'Content-Type: application/x-www-form-urlencoded' \
          --data-urlencode 'grant_type=client_credentials' \
          --data-urlencode 'client_id=<client_id_from_Canvas>' \
          --data-urlencode 'client_secret=<client_secret_from_Canvas>' \
          --data-urlencode 'patient=abc123' \
          --data-urlencode 'scope=patient/Patient.read patient/Appointment.* patient/Practitioner.read'
    ```
###  Expected Response Body 
    ```json
    {
      "access_token": "<the_access_token_to_use_in_your_request>", 
      "expires_in": 36000, 
      "token_type": "Bearer", 
      "scope": "patient/Patient.read patient/Appointment.* patient/Practitioner.read", 
      "smart_style_url": "https://canvas-storages.s3.us-west-2.amazonaws.com/fhir-static-resources/smart-style.json", 
      "patient": "abc123", 
      "need_patient_banner": true
    }
    ```
Using this access token in subsequent requests ensures that records referencing other patients cannot be retrieved through accidental or malicious misuse of the token. Canvas will also deny requests for any resource types which were not included in `scope` of the token request and requests for resource types which do not support patient-scoped tokens.
**Note:** A patient scoped token must include which patient scopes are being requested. Token requests that include the patient parameter but are missing scope or request invalid scopes will be rejected.
##  Scopes 
Scopes control which parts of the API the token can access.
  - **Client Credentials Flow:** Scopes are optional. If omitted, the token is issued with the OAuth application's configured allowed scopes.
  - **Authorization Code Flow:** Scopes are required and must be passed in the authorize URL.
Canvas implements [SMART on FHIR scopes](https://hl7.org/fhir/smart-app-launch/STU2/scopes-and-launch-context.html).
###  Scope syntax 
Most scopes have the form `<context>/<resource>.<permission>`:
  - **`<context>`** — `user/` (staff member; mirrors EHR permissions), `patient/` (limited to the launch-context patient), or `system/` (machine-to-machine, used with Client Credentials).
  - **`<resource>`** — a FHIR resource (e.g., `Patient`) or `*` for any supported resource.
  - **`<permission>`** — `read`, `write`, or `*` (v1 / legacy), or `c` (create), `r` (read), `u` (update), `s` (search) (v2 / granular). v2 letters can be combined, e.g., `Patient.crus`.
Separate multiple scopes with spaces, e.g., `user/Patient.read user/Observation.read`. URL-encode `/` as `%2F` and spaces as `%20`.
Common examples:
Scope | Description  
---|---  
`user/*.read` | Read access to all resources  
`user/*.write` | Write access to all resources  
`user/*.*` | Full access to all resources  
`user/Patient.read` | Read Patient resources only  
`system/*.read` | System-level read access to all resources (used for bulk-data export, e.g., `Group/{id}/$export`)  
###  Launch and OpenID scopes 
Scope | Description  
---|---  
`launch` | Allows external app launches  
`launch/patient` | Allows patient context  
`openid` | OpenID Connect scope  
`fhirUser` | Returns the authenticated user's FHIR identity  
`offline_access` | Requests a refresh token  
###  Resources by context 
Examples: `user/*.read`, `system/Patient.crus`, `patient/Appointment.write`.
**`user/`** — most clinical resources support `read`, `write`, `*`, and v2 `c r u s`. Read-only: `Coverage`, `MedicationDispense`, `Questionnaire`, `RelatedPerson`, `ServiceRequest`, `Specimen`. `Note` supports `read` and `write` only (no `*`). Resources: `*`, `AllergyIntolerance`, `CarePlan`, `CareTeam`, `Condition`, `Coverage`, `DetectedIssue`, `Device`, `DiagnosticReport`, `DocumentReference`, `Encounter`, `Goal`, `Immunization`, `Location`, `Medication`, `MedicationDispense`, `MedicationRequest`, `Note`, `Observation`, `Organization`, `Patient`, `Practitioner`, `PractitionerRole`, `Procedure`, `Provenance`, `Questionnaire`, `QuestionnaireResponse`, `RelatedPerson`, `ServiceRequest`, `Specimen`.
**`system/`** — same set as `user/` plus `Task` (full access). Read-only resources match `user/`. `system/Plugins.*` grants full access to plugin install/list/management endpoints.
**`patient/`** — restricted to the launch-context patient. Writable: `Appointment`, `Communication`, `Consent`, `Coverage`, `Media`, `MedicationStatement`, `Patient`, `PaymentNotice`, `QuestionnaireResponse`. All others read-only. Additional read-only resources beyond the user/system list: `Appointment`, `Communication`, `Consent`, `Media`, `MedicationStatement`, `PaymentNotice`, `Schedule`, `Slot`.
###  Operation scopes 
Some FHIR operations require a dedicated scope in addition to the resource scope. Available under both `user/` and `system/`:
Scope suffix | Operation  
---|---  
`Claim.add-activity-log-item` | Add an activity log entry to a Claim  
`DiagnosticReport.create-lab-report` | Create a lab report  
`Practitioner.send-reset-password-email` | Send a password-reset email to a practitioner  
##  Additional reading 
  - [Authentication Best Practices](/api/authentication-best-practices)
  - [Event Actor](/sdk/events/#event-actor) — how plugins identify the authenticated user
----- END PAGE https://docs.canvasmedical.com/api/customer-authentication/


----- BEGIN PAGE https://docs.canvasmedical.com/api/date-filtering/
A few of the API Search endpoints support date search parameters. You have the ability to filter a Resources query result by a specific date or a date range. For more details, see https://hl7.org/fhir/search.html#prefix
We support the following date search modifiers:
  - `ge`   
Greater than or equal to the date.  
Example: `"?date=ge2021-01-01"``
  - `gt` Strictly greater than the date.   
Example: `"?date=gt2021-01-01"`
  - `le` Less than or equal to the date.   
Example: `"?date=le2021-01-01"`
  - `lt` Strictly less than the date.   
Example: `"?date=lt2021-01-01"`
  - `eq` Strictly equal to the date.   
Example: `"?date=eq2021-01-01"`  
You can supply multiple date search parameters to search in a range. For example if we want to find all the records within 2024-04-11 and 2024-04-20, we can pass `?date=ge2024-04-11&date=le2024-04-20`
The API endpoints that support date search parameters include:
  - [Appointment](/api/appointment/) (/Appointment) - Filter by appointment date
  - [Consent](/api/consent/) (/Consent) - Filter by consent date
  - [DetectedIssue](/api/detectedissue/) (/DetectedIssue) - Filter by identified date
  - [DiagnosticReport](/api/diagnosticreport/) (/DiagnosticReport) - Filter by report date
  - [DocumentReference](/api/documentreference/) (/DocumentReference) - Filter by document date
  - [Encounter](/api/encounter/) (/Encounter) - Filter by encounter date/period
  - [Observation](/api/observation/) (/Observation) - Filter by observation date/time
  - [QuestionnaireResponse](/api/questionnaireresponse/) (/QuestionnaireResponse) - Filter by authored date
  - [ServiceRequest](/api/servicerequest/) (/ServiceRequest) - Filter by authored date
  - [Task](/api/task/) (/Task) - Filter by date
----- END PAGE https://docs.canvasmedical.com/api/date-filtering/


----- BEGIN PAGE https://docs.canvasmedical.com/api/detectedissue/
### 
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.   
<https://www.hl7.org/fhir/R4/detectedissue.html>  
### Endpoints
post /DetectedIssue get /DetectedIssue/{id} put /DetectedIssue/{id} get /DetectedIssue
post
/DetectedIssue
#### DetectedIssue create
Create an **DetectedIssue**.
### Attributes
resourceType 
string 
The FHIR Resource name.
identifier 
array[json] 
External identifiers associated with this DetectedIssue.
The `identifier` field allows for one external identifier to be stored for each DetectedIssue. This identifier may help users identify the issue in their own systems, particularly if the DetectedIssue was added from an external system or source.
Click to view child attributes
system 
string required
The namespace for the identifier value.
value 
string required
The unique value for the identifier within the specified `system`.
status 
enum required
The status of the DetectedIssue.
There is some extra validation when creating/updating depending on what is supplied in the `mitigation` attribute  
\- The status must be `registered` if no `mitigation` is supplied.   
\- If there is only one `mitigation` supplied and the action of that mitigation is `valid`, the status must be `preliminary`.   
\- If there is only one `mitigation` supplied and the action of that mitigation is `invalid`, the status must be `cancelled`.   
\- If there are more than one mitigation and the one with the latest date has an action of `deferred`, the status must be `amended`.  
\- If there are more than one mitigation and the one with the latest date has an action of `accepted` or `refuted`, the status must be `final`.  
\- If there are more than one mitigation and the one with the latest date has an action of `corrected`, the status must be `corrected`.
**Value Options Supported:**
  - registered 
  - preliminary 
  - final 
  - amended 
  - corrected 
  - cancelled 
  - entered-in-error 
code 
json required
Identifies the general type of issue identified.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - https://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string required
The code that identifies the general type of issue identified.
**Value Options Supported:**
  - CODINGGAP 
severity 
enum 
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
**Value Options Supported:**
  - high 
  - moderate 
  - low 
patient 
json required
The patient for the DetectedIssue record.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
identifiedDateTime 
datetime required
The datetime when the detected issue was identified.
author 
json required
Individual or device responsible for the issue being raised.
Click to view child attributes
reference 
string required
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
evidence 
array[json] required
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
There must be at least one evidence element with system "http://hl7.org/fhir/sid/icd-10-cm".
Click to view child attributes
code 
array[json] required
A manifestation that led to the recording of this detected issue.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string required
The code of the Evidence.
display 
string required
The display name of the coding.
detail 
string 
A textual explanation of the detected issue.
reference 
string 
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
mitigation 
array[json] 
Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Click to view child attributes
action 
json required
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action 
code 
enum required
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
If only one mitigation is supplied, the `action` must be either `valid` or `invalid`.   
If there are more than one mitigation, the one with the earliest date must be `valid`. The rest of the mitigations that are not the last date will need to have an action of `deferred`. While the final mitigation can have a status of `deferred`, `accepted`, `refuted` or `corrected`.
**Value Options Supported:**
  - valid 
  - invalid 
  - accepted 
  - refuted 
  - deferred 
  - corrected 
date 
datetime required
The datetime when the mitigation action was taken or committed to be taken.
author 
json required
Individual or device responsible for the mitigation action.
Click to view child attributes
reference 
string required
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/DetectedIssue/{id}
#### DetectedIssue read
Read an **DetectedIssue**.
### Path Parameters
id required
string 
The unique identifier for the DetectedIssue   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the DetectedIssue.
identifier 
array[json] 
External identifiers associated with this DetectedIssue.
Click to view child attributes
system 
string 
The namespace for the identifier value.
value 
string 
The unique value for the identifier within the specified `system`.
status 
enum 
The status of the DetectedIssue.
**Value Options Supported:**
  - registered 
  - preliminary 
  - final 
  - amended 
  - corrected 
  - cancelled 
  - entered-in-error 
code 
json 
Identifies the general type of issue identified.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - https://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string 
The code that identifies the general type of issue identified.
**Value Options Supported:**
  - CODINGGAP 
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the coding.
severity 
enum 
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
**Value Options Supported:**
  - high 
  - moderate 
  - low 
patient 
json 
The patient for the DetectedIssue record.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
identifiedDateTime 
datetime 
The datetime when the detected issue was identified.
author 
json 
Individual or device responsible for the issue being raised.
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
evidence 
array[json] 
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
Click to view child attributes
code 
array[json] 
A manifestation that led to the recording of this detected issue.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string 
The code of the Evidence.
display 
string 
The display name of the coding.
detail 
string 
A textual explanation of the detected issue.
reference 
string 
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
mitigation 
array[json] 
Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Click to view child attributes
id 
string 
The Canvas identifier of the DetectedIssueMitigation.
action 
json 
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action 
code 
enum 
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
**Value Options Supported:**
  - valid 
  - invalid 
  - accepted 
  - refuted 
  - deferred 
  - corrected 
display 
string 
The display name of the coding
date 
datetime 
The datetime when the mitigation action was taken or committed to be taken.
author 
json 
Individual or device responsible for the mitigation action.
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/DetectedIssue/{id}
#### DetectedIssue update
Update an **DetectedIssue**.
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The Canvas identifier of the DetectedIssue.
identifier 
array[json] 
External identifiers associated with this DetectedIssue.
The `identifier` field allows for one external identifier to be stored for each DetectedIssue. This identifier may help users identify the issue in their own systems, particularly if the DetectedIssue was added from an external system or source.
Click to view child attributes
system 
string required
The namespace for the identifier value.
value 
string required
The unique value for the identifier within the specified `system`.
status 
enum required
The status of the DetectedIssue.
There is some extra validation when creating/updating depending on what is supplied in the `mitigation` attribute  
\- The status must be `registered` if no `mitigation` is supplied.   
\- If there is only one `mitigation` supplied and the action of that mitigation is `valid`, the status must be `preliminary`.   
\- If there is only one `mitigation` supplied and the action of that mitigation is `invalid`, the status must be `cancelled`.   
\- If there are more than one mitigation and the one with the latest date has an action of `deferred`, the status must be `amended`.  
\- If there are more than one mitigation and the one with the latest date has an action of `accepted` or `refuted`, the status must be `final`.  
\- If there are more than one mitigation and the one with the latest date has an action of `corrected`, the status must be `corrected`.
**Value Options Supported:**
  - registered 
  - preliminary 
  - final 
  - amended 
  - corrected 
  - cancelled 
  - entered-in-error 
code 
json required
Identifies the general type of issue identified.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - https://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string required
The code that identifies the general type of issue identified.
**Value Options Supported:**
  - CODINGGAP 
severity 
enum 
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
**Value Options Supported:**
  - high 
  - moderate 
  - low 
patient 
json required
The patient for the DetectedIssue record.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
identifiedDateTime 
datetime required
The datetime when the detected issue was identified.
author 
json required
Individual or device responsible for the issue being raised.
Click to view child attributes
reference 
string required
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
evidence 
array[json] required
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
When updating attributes, make sure to supply the `id` field for the evidences that already exist in Canvas so they are not duplicated or removed.   
There must be at least one evidence element with system "http://hl7.org/fhir/sid/icd-10-cm".
Click to view child attributes
code 
array[json] required
A manifestation that led to the recording of this detected issue.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string required
The code of the Evidence.
display 
string required
The display name of the coding.
detail 
string 
A textual explanation of the detected issue.
reference 
string 
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
mitigation 
array[json] 
When updating attributes, make sure to supply the `id` field for the mitigations that already exist in Canvas so they are not duplicated or removed.
Click to view child attributes
id 
string 
The Canvas identifier of the DetectedIssueMitigation.
action 
json required
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action 
code 
enum required
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
If only one mitigation is supplied, the `action` must be either `valid` or `invalid`.   
If there are more than one mitigation, the one with the earliest date must be `valid`. The rest of the mitigations that are not the last date will need to have an action of `deferred`. While the final mitigation can have a status of `deferred`, `accepted`, `refuted` or `corrected`.
**Value Options Supported:**
  - valid 
  - invalid 
  - accepted 
  - refuted 
  - deferred 
  - corrected 
date 
datetime required
The datetime when the mitigation action was taken or committed to be taken.
author 
json required
Individual or device responsible for the mitigation action.
Click to view child attributes
reference 
string required
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
### Responses
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/DetectedIssue
#### DetectedIssue search
Search an **DetectedIssue**.
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier for a specific DetectedIssue.
patient 
string 
The patient for the DetectedIssue record in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
status 
string 
The status of the DetectedIssue.
**Search Values Supported:**
  - registered
  - preliminary
  - final
  - amended
  - corrected
  - cancelled
  - entered-in-error
identified 
date 
Filter by identifiedDateTime. See [Date Filtering](/api/date-filtering) for more information.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the DetectedIssue.
identifier 
array[json] 
External identifiers associated with this DetectedIssue.
Click to view child attributes
system 
string 
The namespace for the identifier value.
value 
string 
The unique value for the identifier within the specified `system`.
status 
enum 
The status of the DetectedIssue.
**Value Options Supported:**
  - registered 
  - preliminary 
  - final 
  - amended 
  - corrected 
  - cancelled 
  - entered-in-error 
code 
json 
Identifies the general type of issue identified.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - https://terminology.hl7.org/CodeSystem/v3-ActCode 
code 
string 
The code that identifies the general type of issue identified.
**Value Options Supported:**
  - CODINGGAP 
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the coding.
severity 
enum 
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
**Value Options Supported:**
  - high 
  - moderate 
  - low 
patient 
json 
The patient for the DetectedIssue record.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
identifiedDateTime 
datetime 
The datetime when the detected issue was identified.
author 
json 
Individual or device responsible for the issue being raised.
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
evidence 
array[json] 
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
Click to view child attributes
code 
array[json] 
A manifestation that led to the recording of this detected issue.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string 
The code of the Evidence.
display 
string 
The display name of the coding.
detail 
string 
A textual explanation of the detected issue.
reference 
string 
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
mitigation 
array[json] 
Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Click to view child attributes
id 
string 
The Canvas identifier of the DetectedIssueMitigation.
action 
json 
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action 
code 
enum 
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
**Value Options Supported:**
  - valid 
  - invalid 
  - accepted 
  - refuted 
  - deferred 
  - corrected 
display 
string 
The display name of the coding
date 
datetime 
The datetime when the mitigation action was taken or committed to be taken.
author 
json 
Individual or device responsible for the mitigation action.
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/4d789a3d5e794c0eb159a126b48c8b9f"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/DetectedIssue' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
          {
            "resourceType": "DetectedIssue",
            "identifier": [
                {
                    "system": "http://external.identifier.system/url",
                    "value": "080abebd"
                }
            ],
            "status": "preliminary",
            "code": {
                "coding": [
                    {
                        "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", 
                        "code": "CODINGGAP"
                    }
                ]
            },
            "severity": "moderate",
            "patient": {
                "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787",
                "type": "Patient"
            },
            "identifiedDateTime": "2024-08-10T14:23:08+00:00",
            "author": {
                "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Practitioner"
            },
            "evidence": [
                {
                    "code": [
                        {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                    "code": "I23.43",
                                    "display": "Code text explanation"
                                }
                            ]
                        }
                    ]
                }
            ],
            "detail": "Detail for detected issue",
            "reference": "https://example.com",
            "mitigation": [
                {
                    "action": {
                        "coding": [
                            {
                                "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action",
                                "code": "valid"
                            }
                        ]
                    },
                    "date": "2024-08-09T14:23:08+00:00",
                    "author": {
                        "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                        "type": "Practitioner"
                    }
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DetectedIssue"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json",
        }
        payload = {
            "resourceType": "DetectedIssue",
            "identifier": [
                {
                    "system": "http://external.identifier.system/url",
                    "value": "080abebd"
                }
            ],
            "status": "preliminary",
            "code": {
                "coding": [
                    {
                        "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", 
                        "code": "CODINGGAP"
                    }
                ]
            },
            "severity": "moderate",
            "patient": {
                "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787",
                "type": "Patient"
            },
            "identifiedDateTime": "2024-08-10T14:23:08+00:00",
            "author": {
                "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Practitioner"
            },
            "evidence": [
                {
                    "code": [
                        {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                    "code": "I23.43",
                                    "display": "Code text explanation"
                                }
                            ]
                        }
                    ]
                }
            ],
            "detail": "Detail for detected issue",
            "reference": "https://example.com",
            "mitigation": [
                {
                    "action": {
                        "coding": [
                            {
                                "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action",
                                "code": "valid"
                            }
                        ]
                    },
                    "date": "2024-08-09T14:23:08+00:00",
                    "author": {
                        "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                        "type": "Practitioner"
                    }
                }
            ]
        }
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/DetectedIssue/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DetectedIssue/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "DetectedIssue",
            "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
            "identifier": [
                {
                    "system": "http://external.identifier.system/url",
                    "value": "080abebd"
                }
            ],
            "status": "preliminary",
            "code": {
                "coding": [
                    {
                        "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode",
                        "code": "CODINGGAP",
                        "display": "Codinggap"
                    }
                ],
                "text": "Codinggap"
            },
            "severity": "moderate",
            "patient": {
                "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787",
                "type": "Patient"
            },
            "identifiedDateTime": "2024-08-10T14:23:08+00:00",
            "author": {
                "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Practitioner"
            },
            "evidence": [
                {
                    "code": [
                        {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                    "code": "I23.43",
                                    "display": "Code text explanation"
                                }
                            ]
                        }
                    ]
                }
            ],
            "detail": "Detail for detected issue",
            "reference": "https://example.com",
            "mitigation": [
                {
                    "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698",
                    "action": {
                        "coding": [
                            {
                                "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action",
                                "code": "valid"
                            }
                        ]
                    },
                    "date": "2024-08-09T14:23:08+00:00",
                    "author": {
                        "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                        "type": "Practitioner"
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown DetectedIssue resource 'd9aefede-da05-4bef-bbf9-63bcf83c806b'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/DetectedIssue/d9aefede-da05-4bef-bbf9-63bcf83c806a' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
          {
            "resourceType": "DetectedIssue",
            "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
            "identifier": [
                {
                    "system": "http://external.identifier.system/url",
                    "value": "080abebd"
                }
            ],
            "status": "preliminary",
            "code": {
                "coding": [
                    {
                        "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", 
                        "code": "CODINGGAP"
                    }
                ]
            },
            "severity": "moderate",
            "patient": {
                "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787",
                "type": "Patient"
            },
            "identifiedDateTime": "2024-08-10T14:23:08+00:00",
            "author": {
                "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Practitioner"
            },
            "evidence": [
                {
                    "code": [
                        {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                    "code": "I23.43",
                                    "display": "Code text explanation"
                                }
                            ]
                        }
                    ]
                }
            ],
            "detail": "Detail for detected issue",
            "reference": "https://example.com",
            "mitigation": [
                {
                    "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698",
                    "action": {
                        "coding": [
                            {
                                "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action",
                                "code": "valid"
                            }
                        ]
                    },
                    "date": "2024-08-09T14:23:08+00:00",
                    "author": {
                        "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                        "type": "Practitioner"
                    }
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DetectedIssue/d9aefede-da05-4bef-bbf9-63bcf83c806a"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json",
        }
        payload = {
            "resourceType": "DetectedIssue",
            "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
            "identifier": [
                {
                    "system": "http://external.identifier.system/url",
                    "value": "080abebd"
                }
            ],
            "status": "preliminary",
            "code": {
                "coding": [
                    {
                        "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", 
                        "code": "CODINGGAP"
                    }
                ]
            },
            "severity": "moderate",
            "patient": {
                "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787",
                "type": "Patient"
            },
            "identifiedDateTime": "2024-08-10T14:23:08+00:00",
            "author": {
                "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Practitioner"
            },
            "evidence": [
                {
                    "code": [
                        {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                    "code": "I23.43",
                                    "display": "Code text explanation"
                                }
                            ]
                        }
                    ]
                }
            ],
            "detail": "Detail for detected issue",
            "reference": "https://example.com",
            "mitigation": [
                {
                    "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698",
                    "action": {
                        "coding": [
                            {
                                "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action",
                                "code": "valid"
                            }
                        ]
                    },
                    "date": "2024-08-09T14:23:08+00:00",
                    "author": {
                        "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                        "type": "Practitioner"
                    }
                }
            ]
        }
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/DetectedIssue?patient=Patient/a39cafb9d1b445be95a2e2548e12a787' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DetectedIssue?patient=Patient/a39cafb9d1b445be95a2e2548e12a787"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
              {
                "relation": "self",
                "url": "/DetectedIssue?patient=Patient%2Fa39cafb9d1b445be95a2e2548e12a787&_count=10&_offset=0"
              },
              {
                "relation": "first",
                "url": "/DetectedIssue?patient=Patient%2Fa39cafb9d1b445be95a2e2548e12a787&_count=10&_offset=0"
              },
              {
                "relation": "last",
                "url": "/DetectedIssue?patient=Patient%2Fa39cafb9d1b445be95a2e2548e12a787&_count=10&_offset=0"
              }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "DetectedIssue",
                        "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
                        "identifier": [
                            {
                                "system": "http://external.identifier.system/url",
                                "value": "080abebd"
                            }
                        ],
                        "status": "preliminary",
                        "code": {
                            "coding": [
                                {
                                    "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode",
                                    "code": "CODINGGAP",
                                    "display": "Codinggap"
                                }
                            ],
                            "text": "Codinggap"
                        },
                        "patient": {
                            "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787",
                            "type": "Patient"
                        },
                        "identifiedDateTime": "2024-08-10T14:23:08+00:00",
                        "author": {
                            "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                            "type": "Practitioner"
                        },
                        "evidence": [
                            {
                                "code": [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                                "code": "I23.43",
                                                "display": "Code text explanation"
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "detail": "Detail for detected issue",
                        "reference": "https://example.com",
                        "mitigation": [
                            {
                                "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698",
                                "action": {
                                    "coding": [
                                        {
                                            "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action",
                                            "code": "valid"
                                        }
                                    ]
                                },
                                "date": "2024-08-09T14:23:08+00:00",
                                "author": {
                                    "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f",
                                    "type": "Practitioner"
                                }
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/detectedissue/


----- BEGIN PAGE https://docs.canvasmedical.com/api/developer-access/
Canvas Medical is certified to ONC's [§170.315(g)(10)](/product-updates/rwt/) _Standardized API for Patient and Population Services_. This page describes how a third-party developer requests access to the FHIR API, the verification we perform, and the timelines we commit to under [45 CFR 170.404](https://www.ecfr.gov/current/title-45/section-170.404).
##  Two kinds of access 
The API supports two distinct access models. The authorization gate is different for each, and it is important to know which one your application needs.
###  Patient-directed access 
An individual patient authorizes your application to access **their own** health information. The patient authenticates and grants consent through the [SMART on FHIR](/api/customer-authentication/#authorization-code) authorization-code flow, and the resulting token is scoped to that patient (`patient/` context). The patient's authorization is the only approval required — access does not depend on separate sign-off from the patient's practice.
###  Population and bulk access 
A practice or organization using Canvas as its EHR authorizes access to data across its patient population, typically through the client-credentials flow (`system/` context) and bulk export. This access is authorized by the practice or organization that holds the data.
##  One Canvas instance per customer 
Each Canvas customer runs its own isolated instance, with its own base URL and its own authorization server. There is no single shared endpoint that spans customers. For patient-directed access, as part of verification we register and enable your application on every Canvas instance that has a patient portal enabled. Two things follow:
  - **Discover instances from the published directory.** The [Service Base URLs](/api/service-base-urls/) directory lists each customer's FHIR base URL in a machine-readable FHIR R4 Bundle, so your application can present the right practice to a user and route requests to the correct instance.
  - **Patients authorize on their own practice's instance.** For patient-directed access, send the patient to the authorization endpoint of the instance where they are a patient. They sign in with that practice's patient portal credentials and consent, and the resulting token is scoped to that single patient. Access to a given practice requires that the practice has its patient portal enabled and that the individual has a login there.
##  Requesting access 
Third-party developers do not need to be an existing Canvas customer to request access. To begin:
  1. Contact us at [developer-access@canvasmedical.com](mailto:developer-access@canvasmedical.com) with your organization name, a description of your application, the access model you need (patient-directed or population/bulk), and a technical point of contact.
  2. We complete an authenticity-verification review. This process is objective and applied uniformly to all API users, and we complete it within **ten business days** of receiving your request.
  3. Once verification is complete, we register and enable your application for production use within **five business days**.
We do not condition access on fees or royalties for the rights the API Condition of Certification protects, non-compete or exclusive-dealing terms, unrelated licenses, transfer of your intellectual property, Canvas-specific testing or certification, or reciprocal access to your application's data.
##  What we verify 
Verification confirms the authenticity of your organization and your application. It is limited to identity and does not evaluate the merits of your product. We apply the same criteria to every API user. You provide:
  - **Organization identity** — your registered legal business name and a verifiable business identifier, such as control of your organization's domain, a state business registration, or a D-U-N-S number.
  - **A domain-verified contact** — a named representative reachable at an email address on your organization's domain who can act on the organization's behalf.
  - **Application details** — the application name, a description of its intended use, the access model (patient-directed or population/bulk), and the redirect URIs or registered endpoints it will use.
  - **Attestations** — that the application has a published privacy policy and terms, that it will access data only as authorized by the patient (patient-directed access) or the organization (population/bulk access), and that you will comply with applicable law.
  - **Agreement to our[Terms of Use](/api/terms-of-use/).**
##  Sandbox access 
We provision a sandbox so your team can build and test before production enablement. Request sandbox credentials as part of step 1 above. Sandbox base URLs follow the pattern `https://fumage-<sandbox-name>.canvasmedical.com`; see the [Quickstart](/api/quickstart/) for making your first request.
##  Registering your application 
Once you have access to an instance (sandbox or production), register your application and obtain OAuth credentials by following [Customer Authentication](/api/customer-authentication/). That page documents the client-credentials and authorization-code flows and the available SMART scopes.
##  Fees 
There is no fee to register, verify, or enable a third-party application for access to the API.
##  Service base URLs 
Canvas publishes service base URLs for its customers. See [Service Base URLs](/api/service-base-urls/).
##  Terms of Use 
Use of the API is governed by our [Terms of Use](/api/terms-of-use/).
----- END PAGE https://docs.canvasmedical.com/api/developer-access/


----- BEGIN PAGE https://docs.canvasmedical.com/api/device/
### 
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-implantable-device.html>  
For information about creating Device resources for a patient, see this [Zendesk article](https://canvas-medical.help.usepylon.com/articles/8311513697-implantable-devices). Devices are not currently used by the Canvas UI, but any devices that are created can be accessed with the Device read and search endpoints, In order to generate the type attribute, a device code must be created and linked to the device via the admin settings on Canvas.
### Endpoints
get /Device/{id} get /Device
get
/Device/{id}
#### Device read
### Path Parameters
id required
string 
The unique identifier for the Device   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Device
udiCarrier 
array[json] 
Unique Device Identifier (UDI) Barcode string.
Click to view child attributes
deviceIdentifier 
string 
Mandatory fixed portion of UDI.
carrierHRF 
string 
UDI Human Readable Barcode String.
status 
enum [ active | inactive ] 
Status of the Device availability.
distinctIdentifier 
string 
The distinct identification string.
manufacturer 
string 
Name of device manufacturer.
manufactureDate 
date 
Date when the device was made.
expirationDate 
date 
Date of expiry of this device (if applicable).
lotNumber 
string 
Lot number of manufacture.
serialNumber 
string 
Serial number assigned by the manufacturer.
modelNumber 
string 
The model number for the device.
type 
json 
The kind or type of device.
Click to view child attributes
coding 
A CodeableConcept combination of one or more coding elements.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the category.
display 
string 
The display name of the coding.
patient 
json 
Patient to whom Device is affixed
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Device
#### Device search
### Query Parameters
****
_id 
string 
The identifier of the Device.
patient 
string 
The patient reference associated to the Device in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Device
udiCarrier 
array[json] 
Unique Device Identifier (UDI) Barcode string.
Click to view child attributes
deviceIdentifier 
string 
Mandatory fixed portion of UDI.
carrierHRF 
string 
UDI Human Readable Barcode String.
status 
enum [ active | inactive ] 
Status of the Device availability.
distinctIdentifier 
string 
The distinct identification string.
manufacturer 
string 
Name of device manufacturer.
manufactureDate 
date 
Date when the device was made.
expirationDate 
date 
Date of expiry of this device (if applicable).
lotNumber 
string 
Lot number of manufacture.
serialNumber 
string 
Serial number assigned by the manufacturer.
modelNumber 
string 
The model number for the device.
type 
json 
The kind or type of device.
Click to view child attributes
coding 
A CodeableConcept combination of one or more coding elements.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the category.
display 
string 
The display name of the coding.
patient 
json 
Patient to whom Device is affixed
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Device/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Device/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Device",
            "id": "c6bf6efc-1fe1-4221-9821-e60acb53becc",
            "udiCarrier":
            [
                {
                    "deviceIdentifier": "08717648200274",
                    "carrierHRF": "=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123"
                }
            ],
            "status": "active",
            "distinctIdentifier": "A99971312345600",
            "manufacturer": "ACME Biomedical",
            "manufactureDate": "2021-02-15",
            "expirationDate": "2021-09-15",
            "lotNumber": "234234",
            "serialNumber": "13213123123123",
            "modelNumber": "1.0",
            "type":
            {
                "coding":
                [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "2478003",
                        "display": "Ocular prosthesis"
                    }
                ]
            },
            "patient":
            {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Device resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Device?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Device?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Device/?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Device/?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Device/?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Device",
                        "id": "c6bf6efc-1fe1-4221-9821-e60acb53becc",
                        "udiCarrier": [
                            {
                                "deviceIdentifier": "08717648200274",
                                "carrierHRF": "=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123"
                            }
                        ],
                        "status": "active",
                        "distinctIdentifier": "A99971312345600",
                        "manufacturer": "ACME Biomedical",
                        "manufactureDate": "2021-02-15",
                        "expirationDate": "2021-09-15",
                        "lotNumber": "234234",
                        "serialNumber": "13213123123123",
                        "modelNumber": "1.0",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "2478003",
                                    "display": "Ocular prosthesis"
                                }
                            ]
                        },
                        "patient": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                            "type": "Patient"
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/device/


----- BEGIN PAGE https://docs.canvasmedical.com/api/diagnosticreport-operations/
##  create-lab-report 
Creates a lab report, lab tests, lab values, and a stored PDF in Canvas.
This endpoint is a [FHIR operation](https://hl7.org/fhir/R4/operations.html) and was developed as a convenience method in order to post all data associated with a lab report in a single request. In order to adhere to the FHIR standard, the request structure for creating lab reports is in the [Parameters](https://hl7.org/fhir/R4/parameters.html) format. This means that an array of named parameter resources makes up the body of the request.
In the example below, the first object in the parameter array is a named parameter called `labReport`. This references a `DiagnosticReport` resource. The `subject` attribute passed here must contain a valid patient reference and the `presentedForm` attribute must contain a base64-encoded string of the report PDF. Only one `labReport` parameter is allowed per payload.
The subsequent parameters in the array must be named `labTestCollection`. These represent the lab tests performed and associated result values. Each `labTestCollection` has a `part` array with `labTest` and `labValue` parameters. Only one `labTest` parameter is allowed per `labTestCollection`. Multiple `labValue` parameters are allowed per `labTestCollection`. Both resources must be represented as `Observation` resources.
To mark a lab value as abnormal, an optional `interpretation` attribute can be added to a `labValue` `Observation` resource. **Only abnormal interpretations (`"code": "A"`)** are currently supported, and the `interpretation` payload must match the exact structure shown in the example below (`text`, `coding[0].system`, `coding[0].code`, and `coding[0].display` are all required and must match).
For the values/units in each `labValue` object, a `valueQuantity`, `valueString`, or `valueCodeableConcept` can be supplied in the payload. For example:
    ```json
    {
      "valueQuantity": {
        "value": 0.7,
        "unit": "mg/dL",
        "system": "http://unitsofmeasure.org"
      }
    }
    ```
or
    ```json
    {
      "valueString": "Normal"
    }
    ```
or
    ```json
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "260385009",
            "display": "Negative"
          }
        ]
      }
    }
    ```
If using `valueQuantity` and a comparator value is needed (i.e. `<1.0`), the comparator value can be passed in a `comparator` key like so:
    ```json
    {
      "valueQuantity": {
        "value": 1.0,
        "unit": "mg/dL",
        "system": "http://unitsofmeasure.org",
        "comparator": "<"
      }
    }
    ```
Supported `comparator` values are `<`, `<=`, `>=`, and `>`.
A `referenceRange` array may also be supplied on each `labValue` `Observation`. Only `referenceRange[0].text` is persisted in Canvas; `low` and `high` are accepted by the API but are not stored.
###  Validation requirements 
The following constraints are enforced when creating a lab report:
  - `labReport.presentedForm` must contain exactly one entry.
  - `labReport.presentedForm[0].contentType` must be `application/pdf`.
  - `labReport.presentedForm[0].data` is required and must contain a base64-encoded PDF.
  - `labReport.effectiveDateTime` must be a full ISO 8601 datetime (a date alone is not accepted).
  - Each `labTest` and `labValue` `Observation.code.coding` must contain exactly one entry, the `system` must be `http://loinc.org`, and `code` is required.
> **Warning:** While lab tests can be posted and are visible in the Canvas UI, they are not currently available to be read through the FHIR API. Only lab values can be read through the Observation resource. 
The bearer token included in requests send to this endpoint must have one of the following scopes:
  - `system/DiagnosticReport.create-lab-report`
  - `user/DiagnosticReport.create-lab-report`
  - **curl**
        ```shell
        curl -X POST "https://fumage-example.canvasmedical.com/DiagnosticReport/\$create-lab-report" \
             -H "accept: application/json" \
             -H "Authorization: Bearer <token>" \
             -H "content-type: application/json" \
             -d '{
            "resourceType": "Parameters",
            "parameter":
            [
                {
                    "name": "labReport",
                    "resource":
                    {
                        "resourceType": "DiagnosticReport",
                        "status": "final",
                        "category":
                        [
                            {
                                "coding":
                                [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                                        "code": "LAB",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "subject":
                        {
                            "reference": "Patient/4cc6fd69f81042a0b6d123e2080a7c1a",
                            "type": "Patient"
                        },
                        "presentedForm":
                        [
                            {
                                "data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoVW50aXRsZWQgZG9jdW1lbnQpCi9Qcm9kdWNlciAoU2tpYS9QREYgbTEwNCBHb29nbGUgRG9jcyBSZW5kZXJlcik+PgplbmRvYmoKMyAwIG9iago8PC9jYSAxCi9CTSAvTm9ybWFsPj4KZW5kb2JqCjUgMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDE4Mj4+IHN0cmVhbQp4nHWQ0QrCMAxF3/MV+QG7pmmaFsQHQfes9A/UDYQ9OP8fbDfdQFhTmnIP9zaU0JbaUTk0ObwN8AKjMqm/XkTCWtcW58vYQ9My9m+oPFJAshJwfEAHl78EdXWXjK/jmKE5eyRvQl2KuQNapzBeUyTlhHmAqrFxquw5Yr7j3lrWA+YnqGEXUhAunhn4OIFoSIisxgVIWByRnKz6nOSNVUoqugDLG0B44wmvWyBN4JTLv3wAWrRKswplbmRzdHJlYW0KZW5kb2JqCjIgMCBvYmoKPDwvVHlwZSAvUGFnZQovUmVzb3VyY2VzIDw8L1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldCi9FeHRHU3RhdGUgPDwvRzMgMyAwIFI+PgovRm9udCA8PC9GNCA0IDAgUj4+Pj4KL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KL0NvbnRlbnRzIDUgMCBSCi9TdHJ1Y3RQYXJlbnRzIDAKL1BhcmVudCA2IDAgUj4+CmVuZG9iago2IDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9Db3VudCAxCi9LaWRzIFsyIDAgUl0+PgplbmRvYmoKNyAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyA2IDAgUj4+CmVuZG9iago4IDAgb2JqCjw8L0xlbmd0aDEgMTg0MjgKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA5MTQxPj4gc3RyZWFtCnic7XoJeFRF1vapureXdLqT29k76aRv0kkD6bAlYY+kQxbAiOyYYJAEiIRFWQIIihLGPaIwqKjoCO64dxLEgDowbqO4gIo6boCIiuMgyCgqSu7/VnWHBHC+n/H/vu9/fJ65N+etU1Xnnqp7zqlT1d0hRkSxAJV6DS0pLWOFLI+I7UVr/tBRI8deMWV9IpFiRf2uoWPHD7H92bIC/UHUe40c2zN3ccLTLiK+AfXqCSUjKkatnvk9Ud86IuctUy+qmctXsLvRfw76q6YuWqDf437/ayLzL6BxF86dftHrSyrXEjlGoX7x9Jr6uZREEdBfAHlt+uwlF046+GkrUdeuRFGD66ZdtPiF63+4ARPeRmTdUFdbM21v3MvQx+NIDIqGmLyIdDyPOVJm3UULFmd8yf9MZLoLbdWz50ytydqe/hbe5370N19Us3iuqcXRgD4xP/3imotqE6t7fwJjVKCtZO6c+gVGNq0BP1v0z51fOzfrvRFbidx4v0joJYWsxMlJzDDAC1tW0BEqoD+RBe0a9aQJ0PYYZE2oKyQvo4vQ+SsXnrcMbjuXijU69uSxSzXZctJVIVts1AO3qWZ+zRTSpy6ZP5v06fNrZ5FeVztlPumzaxZcTHqHTrKHeU7mcJsiZ9sPN6OhNBw4FjfDbM8DimdMrrWPttz61uTogu+tKVb52L2fdckW5WujBm069uTx6RpZheaITrPk0iZEcWFrxCGuhqGMknYyY1bj6EKaSwtoPSxGsj4N9XpRNz47cU897c0V5Tq2Cla0mtaaRISmhErlLbqQx1hNPNKscnGp4RmcuEaMPHckBTDSetM7baNZnmUwaw4Ih2F81Wd6Rs5CDdt1CFWRIi2aE7KotKV4C+E3A1K8E8868Rh1Vu18yHbGsP2FHIcFmCSNQnPsgXGTw77oJ30w3PhI1IDDjFSaAIKPUPvfvpb/1zdbxW9VRpx+q8PFbZ5p8UgtFpoookDFeqaZ1BDmGay8KMxzxEVdmFfgo65hXu0kY4KNosK8GRxREc2nGVRDs2kEomcC1aJej5Y5JKK+D+zam3qhf4RsmYNYW4IIq0XfcLoI7dMhezFQp+6gDm06jYHUdFoIvgatJ9c65B6GZC5G6I1bxG+d1H36aMWozQcvsAbtoRn2kGPODo83AyPUoa8+PHq9fJtFwGnUw9x5YQ34X4+C/9FL/QwW/H95vp7KQOWwS+wZyl97gicqxHOZpi3kAiWbHiKX6sPOQ8aXoAOibJthHBD9ouR/x0OtYSLaQI+zGfQ4baXn2WE89SRtpo30CiVSCd1FS+kWjGRG7L9C18OnYxDBJXQLcxkbsRvcg0i+h96A7Hl0BW2hBJZkfEXL6GrlHTx1NTkoA9ExCpFyIzvHWIhstEe9EtnhHETOXNZgVBg3GauN++kB2qy8YhynSKyOqbjfML4x/c34GBFdRbfSHbSHrY54CivqPKy7zcqfEFNrlUkqM6YbxzCDdLoEc1ARs2+wbdwP7bX0JUtiS5ViaLnPCBovQspNkxCba2kL68OG8nRTlTHCeIMSMMZiaL2DmmkT7lZ6jj5kdtNh437jMLkoB6tsGezxJtumtB1f3lYIi5lgpW40AD1z6M/0V9rJvOwvfI7Jbso1BUyXGruQKXvTeMz2ITz5BfuBX4F7mfKyWmYMwZq/mv4orE0v0acsmfVkI9kE3o3P4Xcr85FRc+RKnIa1dD3dDu27mZ9t4na+Q7lPfVT92ZzatteIgkd8dCf25b8wB95UZ/XsD+w99hkv5pP5nXyfcov6sPq2pQZvfQGyxI30KP3AYlh/Npqdz+rYUnYt+yO7g73BdrIDvIiP47P4IaVOmac8pw7BPVatV680XWO6wXygraLtxba32n4wco1raDTiYTlmfyvdjTfbTDvoA9x7aB8zsUgWhVtn6Ww8uwz3FexGdi/bwB5mGzHKTraPfcWOsO/ZzxyJkpt5Ck/nGbi9fD6/hN/C7+I7cO/k/+A/KYlKhuJX+igFSqUyB7O6VlmF+ynlUzVZ3aEasHOuaY1pnWmD6VHT86bDZrvlD1ayvv7Lfcezj+9uo7br2ta0NbdtND6lePgwGVbw4BQzGnmrBrl7Mc4rDyDO32F22C6ZZbPB7BxYZjKbyeaxxbDkVWwte0DO/Qn2LKz0PjuEOTu4W865B+/Dh/CRuC/gtXweX8VX8438PX5MsSiRSrQSr2QrQ5VJSq2yQFmirFGCyuvKJ8o+5ajyC25DtakeNUP1qX51qDpZXajerX6pfmmqMr1m+txsM19kvsbcav7W0tcy2DLKMtoyybLSssmyy1qN6HyBnqKnO+cBtldZrpQqT9FNPE918Tf5m4jnyTRNGcELxTmWXccvZxt5pmmxeRAfxM6lw6oPtn6Zr+NH+SBlBCtnY2km7x3SZo5TH0FRoL5AB9Vn8W5vQvNis51dwQ+Z7dTMZN5mLym9VL/yGn2o7GEW9R76SLWxRHaQP6SMQhQ8pw42VVC6chc9ocxjl9NTvBRHkZ+tKxDH57JHkBfGsVz2o4ITJj8XUdRP+YyupFn8b3QQ6/g6uo1NU6fTTZTHltKX9CBWRTfTxeZsczx7lc9QG3ks20hcfVjsISyTKaY4uopNUtaaD/EPsLvtUG20W3kMs9/Bn8Aeftg0htVhBVxO19A8YzktMVWob7PppLAJlKXuRXZbquSq6SiXIatUIadtwuregjxQpIxASxIi5xzExXhkiLW4b0eeUBFBM7DGz0MWe5M2msfxVppuimLIOsjGr7WNoYnGg3SHMZ0uNlZTd+SDa42l0LiBPqeVtIFd3XYZ9tE0rJzd7BxTGd9hKjO680b+AR/L15zsX1g7iyXR33E/gcpgnO8a1fdxti00VhjvIrq7IsPeQVPobNqPt/wGIwxTtlFe27m8yShT5uJ999Bo4yHDw2xUZ8ymkfQsPWAxUY3FDx8H2dt438uolo8xFii1bTNgh5WwQgDWWoj8c32gePy4okDh4LMKBg0c0L9fn/y83N69evbonuPP7ta1iy8r05uRrnvSUt0pya6kxIT4uNgYpxYd5bBH2iKsFrNJVTijnFJvWbUe9FUHVZ932LDuou6tQUNNp4bqoI6mspNlgnq1FNNPlgxA8sJTJAMhycAJSabpBVTQPUcv9erBN0q8eiubOLoC/I0l3ko9eFDyIyS/SvIO8OnpeEAvTaor0YOsWi8Nli2qayytLoG6pkhbsbe41tY9h5pskWAjwQUTvXObWOJgJhmeWDqwCSdjByYVTPaWlAZd3hIxg6CSVVozLThqdEVpSUp6emX3nCArnuqdEiTvkGC0X4pQsRwmaC4OWuQw+gzxNnSD3pSzrXFFq0ZTqv32ad5pNVUVQaWmUozh9GPckmDipfuTOqpQHlNccW3n3hSlsTRphi6qjY3X6sH1oys696YLrKyEDjzLs8qqG8sw9AoYsXysjtH41ZUVQXY1htTFm4i3Cr1frbdUtFTP1IMR3iHeusaZ1XBNcmOQxixJb05ODmw29lJyqd44rsKbHixM8VbWlLib4qhxzJIWV0B3ndzTPadJc4YM2xQVHWbsjs5M7Yk+yUlxwZWPOWFZJmbkHY6ACOpTdcykwot36i+gtj81Tu0PMVyVDE8Fp8EjM4IRxdWN2kDRLp4PmrI0r974PSECvAf/cXJLTbjFnKV9T4IVcXIi1NDfzgf9/mB2tggRSzF8ijkOlvU+3XMWtXKvd66mo4D5aBRsW1M5sCfMn54uHHxDa4CmoBJsGF0Rqus0JaWZAj39lUFeLXq2tffEjxc9De09Jx6v9iKSN8oTd3zQ6jvxF60lxJbWDQyyhP+iuzbUXz7WWz56YoVe2lgdtm35uJNqof7+J/rCXDC2uEJJ4WGOpyiyF0FZdUJYVCrsQTULf2YZ1NNaLVZEpWxhellQqx4WwkpbevoZPtRqHBZPyaLjsfA0gwP9J9cHnVQ/aXr2RgUTxlZZPm5iY6PtpD6EWmjA4eECEU/jKtL14iCNx8rMwl+rsa2/oMqUYAAmKxYCiL9QU7h6kmBKmK/EJaKze04ZEl1jY5lXL2usbqxpNRqmeHXN27iZP8+fb5xbWt0eOK3GlhtSgmUrKmGrOjYQi4LTkCYvu250U4BdN3ZixWaNSL9uXEUzZ7y4ekhlUyb6KjbrRAHZykWraBQVXVSonOElm7lVyqdsDhA1yF5VNsj61FZGss3a3sZoaisPtWntbRxtaqgtINvEJXJM8biKztEjl2Rld7nh4XMLVUVarad873GGl/nUulnt3GeGTntExG/TbTm1blE694maw2YjUunfv/5vuqEzOjLyt+mOOKVutXZogZlFTbPb/3t0R0SonfuEbqfDIT4z/XfoNnXuE7pjo6J+m277KfXIyI7IgZlt0BmvaafH02/SbT9JtxgpKSbmdJ+fyRV1at1h6dxnRy0lLk769d++tFPq0dEduqOhHjpTExJ+m+5Tv9XQtA4tGDcaNT0p6XSf/xbdTqetg4d66Ex3uX6b7vhT6jGddMOFTujMcrvFd63//pV46lhxHVowbgxq2bp+ejydyZV86liJjs7jxkFnD68XCes36HafOlZyR1RiXDFSrs93eqyeyeU5dSx3hxaM60Ktb7duMh7/7Sv9lHpaWoeWNKwb1Abm5Jy+Ds7kyjylrusdWnSsG9SKc3NPj9UzubqdUs/K6tCSRZSBWnn//qfH6plc3U+pZ2d3aMkm8qE2dvDg02P1TK78U+o9eiR18FAPnVWlpafH6plcp35/nJeX0sFDPXROKy8/PVbP5Bp8Sr1//9QOHrENnZtpnNK1xZfk2fms0o32grjSrdmf6tmsdFFSmwd5Aq2KtyUmPje6qLui42zUU6IOnAN6ErRVEb/TTFbSxG8owGWgBtCToK2gnSDsFEDRq4PmgNaB9ooeJVVxN+seraiL4sKzLpy1opVEOgQyQAp5gD1BI0GTQStB60BmKSda5oCWgbaCDsuegJLYvDoPc09svkEWLTNn58pqTahaNUlWW86rDJUjRofKkuEhsYEhsd75oeYeQ0Jll5xQGZOV2yBKmyN3W1GCkoCXTMDE5wIZf5GiGUMCWK/EUxDEFXO4JaDEtGT6ctdtVVRiClcYTSOPsU1hzQ5nbpGNG/wQkrGHf8MPhnr4wZYoZ+66orP5PnoStBWk8H24P+Wf0jK+V9gcWAhaB9oK2gE6BDLzvbj34N7Nd1M0/4R6ggpBk0HrQFtBh0AW/glQ4x+Lz1ESBV8I4vxjoMY/wmt9BIzmH4L7kH+Iqb3T3G9A7mbJ+HuGGU9WmElMCTMxCbmt/O3mn7ohonzwNCLqGSUDoZmnZDRn9fa0KknNBTM8rfyzFt3vWV/Ui++iIIhjJrsw8i7SQaNA1aC5IDO498C9Rw2gVaD1oCAIUQbUQDrfDnod9B71AgVAo0BWvrMZw7TyHc2+IZ6iBP4m/ytSgoe/wV+R5ev8ZVm+xl+S5aso01Bu5y83p3moKBL9hGc0lBrKnug38b+0ZMZ4jCIn3wrbeYA9QYWgkaDJoJUgM9/KM5qneWKg5BnajoOChzfTV7J8kO61UmCmJ+ArRgDqAnwDzwIHWKev8/GAb80dqArw3bQanADfVSvACfBduhycAN/sReAE+KbNBCfAN3EyOAG+kePAAVr53U9ndvH0GzmL6UXR/BJY6RJY6RJY6RJS+SXipp9UMbc7m7OzYbG1AX+3bE/DFtbwLGsYwxruZQ21rOEK1rCcNRSwhgtYg581uFlDGmsIsIZnWH+YooEFNp5UHRBIYg3bWcPjrKGeNfhYQxZryGQNOusXaOXpzcPzZFEqi5YisehQnjUY2Seap8Oi6Yj5dOSErcAdIEPWAhDSM0LCrjRRZrRkF4bqPQbmzikaxl/Agy/ADS/QHpAKB72AMHoBSl6AgmhgIWgyaBvoEMgAmSGdgYmvlBgN7AkqBE0GLQMdApnldA6BOM0JT/FJObGe4UmPFDX+Am7xQ0E6Tw+kam7Nrw1TVrpZdBobmWak8X4kzqQ4mFmdrcyx6QfHjz84KKIogt/EV1IqHLEqXK5s/inV08pub/Y94ymKZ7dRmoqoYwPIx7JQ9qd6We9Dbqso88nNH0WZ2+yegMeim305ni0sSjy1yfOTe7/nK3crB3vA/Yznfb1VZc2ed9Hy6CbPLvf1nld7tlrR8qyvlaHYokvRze7+nse3S9Hl6Fjb7LlCFJs8l7uHema5ZUdtqOOCetQC0Z4xvomeYdBX4p7iCdRD5yZPofsCT0FIqo94ZpOnF6bgD7HZmGw3txzUmyYVju/XyuoCOZY1lgrLSEtfS64lx5Ju8VhSLSmWOGuMVbNGWe1Wm9VqNVtVK7eSNa7V2Bvwi9/548zynzbEZ2hGquQ1TvLfBuS/AnBm5XQ2BWOVcl4+dggrD26bSuVT9ODRsd5WZhs9MWjyDmHBmHIqHzck2N9f3moxxgT7+cuDllHnVzQxdlMlWoP8ulZG4ypamSGark4R319uJsacV9+YIsquV99YWUlJCYsKkwpjBjsHlJX8ClSH0d9xJZ3EpwbXlI+tCD6SWhnMFYyRWlkevFl8wbmZHWGHS0s2s29FUVmxWRnMjpSOEe3K4JLKyvJWNkHKkc6+hRwi5lspZ8XGLORIt6aF5NaG5LLwPOQyRQG5iAjKknJZERFSTmVCrqk+s7SkKTNTyiTqVC9l6hP1zjLbsyCTlSVlEhpou5TZntAgZIKDpYjbDZE0txRhyeSWIm6WLEUmdIj0DItcf0LkejmSwjpk3CEZx952GcdeyPjP9Kod4vezlkGVU6vEl8PV3tJaUHXwhkV1ScGGKbreNLUy/K2xr3rK1DpR1tQGK721JcGp3hK9aVDVr3RXie5B3pImnBfHVTRVBWpLmgcFBpV6a0oqW4aOyu930ljXnxgrf9SvKBsllOWLsYb2+5XufqJ7qBirnxirnxhraGCoHItkjI+qaLLSkMriqlDZwiNtiNfqlPTKIQna3MEyeAelJ12RsgWnlQ0U6a8M2r1Dgg6Q6Ope1L1IdGFNia4o8QtAuCvpikHpKVvYhnCXhmandwj5FyysX0hJpTNKQn/1uNC0YKEweAj99f/qQl9pMFBTUr8AnxKC2WPLg4WjJ1Y0WSxorRavFBzY3hYZWdpqbAs19kDjQNGoKCcERVuBaIuICAue7v+F4bJYrIIG/kwLC6SxBVRfqQTTysdxpIJx4a9at+AsJbaH+kq8YD3zs/p2HeFp+/0UqpN453ZasDDMhW2xIFyGnsQj9e0mOXEJY/lPWGwBFIrk1YtI3WLaQhbaHXCZud0+ZLxFotkSGQleIms1ftooGAITcArObLI70C0R3T9vFAy6fw44BWfiaarCSf74FdHK61t0lanIx0+bdcZ7KkwB/xRj4tNAq3EgEKlpfDxZo6O50HFko90umX0bHQ7J/IIWs2Da0CIYaLRuuiPJrx0NvdykAu070PH9k77QCrQCKiwsOF7QuxfreP10Z3qf9Ph0J49tS1Ub21JMjscfP/ZPpPAy44CyBxZwUirbGlhq46ojy5HvKHGY+sT1cZ/Hx9nGxI11T+fTTLURU+Oq3ds8u0zvxn7i+jz287hDiV+7Pk/d6zE8CR6PP7kgoSC5PHmuZ5XH0oNnOnokDOR9HOW81FEWN9x9nm2CY7rjc/OXCcfYd1Eai1eiIrVoSnFHWpxki3crkUmtxo94vyHjBfO0cEJSnrDPkael7bOc0e0CYL7bKATAHAl0Ed3RWZq208k0Z8BZ7Wxwqp5AZCQf7wkICzpjhH2deCjgFDZ2mqOigEmyT2iIjIw0j3dGaZpZ1L+R1naGBgsxgWoxmnNBjFUMH2MXtZgoMW5MpkWTUaOJnq2WHZY9FsOieiyF2GcVS5qYhSVJONSSJsaz2MVYFrvQbEkWA1lcafmjkvznat+FfTnP7x9xEMzxTtE7aV6BJtq04/6C/YjdwoOFBYKcA5wxA3r3okls3iSal97H7M3w+frkx/TNy01IdOY5WVxCXm7fPvk+b4ZZ6V/74rJ3F87cdWX1mp4tx/XHFi56YMNli++55u4VP9+3jimNo4t41LEyHvP69r+8/OHrL4r/fCw3Dqhp6mCKR3TcHUj0kDuej1cmmSZFjI+sVWaZ5kTURlrjW4397abaHxgjuFS3wC4xH5iOxR1NVnvHDHT1dhfFjEguco+OqXKNcdfEXJRc415sXhx/lB9N0iiBRTsSE0clVCfMxUdCd/Qqbb3GNU1NcdsstIU/QszYtlG4EattW0C6SmOM3RrrViMTW43DMhwSxeIRXgHz4ybhkMSAo9X4WK4jh/CsmBWYv0sXO4SqiC7Z+UEHcyR7UGvJ8uWL8uk0b34vD/MkYO0FqoSihDzNKobQpNc1GQdapiWQmZ3f7msZFcKzQL2T393S71HS727p8QTpffi9Xye/w8n+EcLn+9GGGDg6T7TJSIC7j09CR+HBmAE9JxUcn1fA4PYBwvNsEqHHz+bNZ4lmeJ+cGuXlkjPOkp4gXM/SfV2k8y/YkvPN5q/aDrG4j99lUeyXA7bmq6euOP4hH23vP+H6pQ+zCYn3bWQepjA769q2u+0nTX9ySx279ZriugdFpoxFODSY3qFE1i2QFhfBol09Xb1cAddc1532uxwPO6zJjq6OoGubS3UJswaSPfmpVodij3bbWDz3x8Wq+CRvWxfH4oxYacPYgJoomURpzERpvsQsFYf91Uys+20tvfvnizLgd3vyVxFzBcTqdQUcWL0UJ3NmV5kzM8R6ppxwtsR6lgk0TlichLNFtID5YmN0tGSOPS3z6X1JrmfZFkqno8xGOCYe7bzg/H7kVORSueoO+g9OEkm1AGm18OAAJwxfvCQQpznNERaz1czNWkRMCjnN0SnYwvzZy5czP9bj/Dynt09en/x+fbEcEy3CDfHxefFeZ/O6dbHJVy46pyqlf+6Ykh07lLUr5s3KLzsv5k+2suopK365ECvv2rYZajpWXgylsTWBBXatu3aWVq6phXpQ5x69m92bmhufmzokda6+SrcOTByYcnbi2SmV1vPtVYlVKTOts+wztIsSZ6Vs09+J+yTpk+R30vbH7U/bqxt6glf1a/74PupArUw9W5uofR75dWqbFumMwsJzmy3MnOCOiqQoV/tqcrWnW5dIhR7hLVfmThvTbAFbta3Bpuoy2eoy2dpg50CkcIstKVw/Jjc0m1h/wiU2oU54wib2vj7CFbYFLDaP54XTayixhpJsFtE2xlax9SzIDjPVwwrZSMSoWJepwutME4MwTYzANDENJjMsJI5Kv0vRBDEcs4uhWIxYfMzlGdoviXVefcix8wtGaGIFfrdfO97RGlqByLaFB50DwtkWsjQv1pkXL1ybkBAfx0Xm7eJUOuXba+8fuLruup0zF+65bOLKHs4HFy1+9KEF9U1tM0zPNY4evcK4/b62n284Z+Dxn5X733jxtXdf2/6+WGeF2I+b4PdeSlMgNrRAkiS6JHZt90WXdsbXzmS1M5ntjLedyWhn0tsZXeyGywSnZsRlDIw4O6Ikc0JGbcbSiJsirsp8MPbRnOcVR0RiclJir/Kc9xJNKXw851ousyVVWasiqmxVkVX2KsdM68yImbaZkTPtMx0bfRu7RHfxZXbJ7NY3c6KtMnKab1rXBd4FmQ2ZN9vusq/uelvOrb3utz1sv6/L/V1bfC/5EuS7CG9ktDPediaznQm/r7n9FcztL2Vuf01sNq3G7kBM2oCJ1i5ZdpuarPvi1cgeqcmt/JFAhitHHgRcha6RrsmuJ107XOZol8c1x7XHpXpcK13c9RxyRTyym9xjAnFCXGMBxjW2k3FiGuNiz2mJS8iXe48W5cxnrEdV6uxUnuqOt6hiGuIhVWQYEXKCCcSKkFPdPSI9ySw50xWITcrPFY/3kTksKYQidl0JInZdunjSpYunXJp4K5fcJUQvfL+Fn08W48gmeSjNzIaip9wDdmazbDGmeB7MgY1CqWTE89ki8wkVYL7bJLRkJ8sZpGPHq87dlssLcxtyea7YRjNJToU0ebzUQ8bnMkjkG8lo8Yi56TIK9cxoudai5dyjdSGMs9ixgE9MITpKjB8tzzjRZnlOy9hDrJBGIq+5eod3vUnzRrSvPbHCkJL8B+efq+H4E8rD88Te17E60YltEGXhwXnYBeVy9WOdygK7If6wKSaGMnOgS/c0rykux+fUYrRYTTFnOPQUiuhqSWGm7oC0OFTTo7wplOF12K3dbCmsa5cIm9mvppBHS01h+NAhDtIhkMfobP/y5cupU7Jgk+Yjx59oEEKx/RJCy7+Lr0sP3ie/b79QekDul8k/LjEBdxqPjxNbta+wOfr6y5Yu7pN188t3jCzqn/3HsZc/N9EZtNfPWDozIaFnylVbb5sw4+XLd3zAznLPml9bcpY3KSt3+PJzhy7p6vEPu2x60piqMf287tRYW2Ze0dKqievOe0xkkEzjCM823YGd2rOZ7PjMIDwQ2RpmrO2MpZ0xtzM2EeZeX36EiJKxYBpcjJjdYWMKJWgR/mgbdgYlMlrLoAzmOClZ20LJ2s4Mi7U0orTaMtfSYFllUcmiW9ZbgpZtlp0Ws0XsAGLbtoR2AMkc2SjSuCV02g4z8tgk9g0Re2AOiw0FnFmenkSAywPUFj6Tkljfpgs7PghJzyB9HywQCbxA2/9dgTwrHy8QqduZl6e9Ks5MYdGsxNB5WWzTzn5OsTXHCQ9yLfmcgimzc666quWpp2L9XdPuWacNrr2XT13BLLPbblxx/OYROaHfqxRSmLhMioI0wSjJ9I/IbfSj1SArWY02iqAI4zjZyCb/rz0SaIdLjpODHMAoidEUBdQoGugE/oI93wmMpRhgHMUC44E/UwLFARMpHpgEPEYuSgSfTC7wKZQMdEtMpRRgGrmNn8gjUadUYDp5gBmkA73AHymT0oFZlAH0AX+gLuQFdkUc/UDdyAfMluinLsZRyqGuwO4Se1A2sCf5gb2oO7A38HvKpR7APOoJzKdexnfUR2Jf6g3sR3nA/pRv/JMGSBxIfYCDJBZQX+BZ1A84mPoDC2mAcYQCNBBYRIOAQ6gAWAz8lkroLGApDQaWYfc8TEMpABxGRcDhNAR4tsRyKgaeQyXAEfjce4jOlTiShgJH0TDgaBpufENjJI6ls4Hj8BnoII2nEcAJEs+jc4EVNNL4B1XSKOBE4EE6n0aDr6KxwEk0DniBxMk03viaqmkCsIbOA04B/p2mUiVwGk0E1tL5wAupyviKpkuso0nAGXSBcYBmUjX4WRJnUw3wIpqC9otpKnCOxLk0zfiS5lEtcD5NB9ZLXEB1xhe0kGYAF9FM4CXAz2kxzQIuoYuAl9LFwMskLqU5wMtpLvAKmmfsp2USG6geuJwWAP9ACw3x/9qLgFdJvJouMfbRNbQYeC0tAV5HlwKvp8uMT6mRlgJvoMvRsgL4Kd1IVwBvomXAlbQcuAq4l/5IfwCupiuBN9NVxh66ReKtdDVwDV0LvI2uQ+/twD10B10PXEuNxm66k24A3kUrgH+SeDfdBFxHK4HraRXwHuAndC/9EXgfrQbeTzcDH6BbjI/pQbrV+IgeojXADXQb8GGJj9DtwEfpDuBjdCfwcYlP0F3AJ+lPwCDdDWwCfkjNtA7YQuuBG+le4wN6iu4z/kabJD5N9wNb6QHgZnoQuEXiM7QB+Cw9bLxPz9EjwD9L3EqPArfRY8C/0OPA5+kJ4Av0pPEevUhB4EvUZLxLL0v8KzUDX6EWYxe9ShuB2+kp4Gu0Cfg6PQ18A5+CdtGbtBm4Q+JO2gJ8i54Fvk3PGe/QO8C3aRf9GfgubQW+R9uMt+h9iX+j54Ef0AvAD+lF4EcSP6aXgJ/Qy8Dd9FdjJ+2RuJdeNXbQp7QduI9eA34mcT+9Dvyc3gB+QW8Cv6Sdxpt0QOJX9Bbw7/S28QZ9Te8A/yHxIO0CfkPvGa/TIXofeFjit/Q34BH6APhP+hD4ncTv6WPjNTpKnwB/oN3AH4Hb6SfaAzxGe4E/06fAXyQep8+MV6mN9gMN+hz4n5z+P5/Tv/2d5/Svzzinf/UvcvpXp+X0A/8ip395Wk7/4gxy+v4TOX3+STn9s3+R0z+TOf2z03L6PpnT93XK6ftkTt8nc/q+Tjn909Ny+l6Z0/fKnL73d5jTP/j/lNN3/Sen/yen/+5y+u/9nP77zen/6pz+n5z+n5z+6zn9ld9/Tv8/7yjp0QplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9BQUFBQUErQXJpYWxNVAovRmxhZ3MgNAovQXNjZW50IDkwNS4yNzM0NAovRGVzY2VudCAtMjExLjkxNDA2Ci9TdGVtViA0NS44OTg0MzgKL0NhcEhlaWdodCA3MTUuODIwMzEKL0l0YWxpY0FuZ2xlIDAKL0ZvbnRCQm94IFstNjY0LjU1MDc4IC0zMjQuNzA3MDMgMjAwMCAxMDA1Ljg1OTM4XQovRm9udEZpbGUyIDggMCBSPj4KZW5kb2JqCjEwIDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0ZvbnREZXNjcmlwdG9yIDkgMCBSCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL1N1YnR5cGUgL0NJREZvbnRUeXBlMgovQ0lEVG9HSURNYXAgL0lkZW50aXR5Ci9DSURTeXN0ZW1JbmZvIDw8L1JlZ2lzdHJ5IChBZG9iZSkKL09yZGVyaW5nIChJZGVudGl0eSkKL1N1cHBsZW1lbnQgMD4+Ci9XIFswIFs3NTAgMCAwIDI3Ny44MzIwM10gNTUgWzYxMC44Mzk4NF0gNzEgNzIgNTU2LjE1MjM0IDczIFsyNzcuODMyMDNdIDgzIFs1NTYuMTUyMzQgMCAwIDUwMCAyNzcuODMyMDNdXQovRFcgMD4+CmVuZG9iagoxMSAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMjYyPj4gc3RyZWFtCnicXZHNasQgFIX3PsVdTheDTpKZoRACZUohi/7QtA9g9CYVGhVjFnn7+pOmUEHlcO539Cq9tY+tVh7omzOiQw+D0tLhbBYnEHoclSanAqQSflNpFRO3hAa4W2ePU6sHQ+oagL4Hd/ZuhcODND3eEfrqJDqlRzh83rqgu8Xab5xQe2CkaUDiEJKeuX3hEwJN2LGVwVd+PQbmr+JjtQhF0qd8G2EkzpYLdFyPSGoWRgP1UxgNQS3/+WWm+kF8cZeqy1DNWMGaqMprUucqqXP2riwlbUzxm7AfWGWouk/bZWMvOSl713KLyFC8V3y/vWmxOBf6TY+cGo0tKo37P1hjIxXnDxIJhhgKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUwCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL0VuY29kaW5nIC9JZGVudGl0eS1ICi9EZXNjZW5kYW50Rm9udHMgWzEwIDAgUl0KL1RvVW5pY29kZSAxMSAwIFI+PgplbmRvYmoKeHJlZgowIDEyCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxNSAwMDAwMCBuIAowMDAwMDAwMzk3IDAwMDAwIG4gCjAwMDAwMDAxMDggMDAwMDAgbiAKMDAwMDAxMDgxMSAwMDAwMCBuIAowMDAwMDAwMTQ1IDAwMDAwIG4gCjAwMDAwMDA2MDUgMDAwMDAgbiAKMDAwMDAwMDY2MCAwMDAwMCBuIAowMDAwMDAwNzA3IDAwMDAwIG4gCjAwMDAwMDk5MzQgMDAwMDAgbiAKMDAwMDAxMDE2OCAwMDAwMCBuIAowMDAwMDEwNDc4IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxMgovUm9vdCA3IDAgUgovSW5mbyAxIDAgUj4+CnN0YXJ0eHJlZgoxMDk1MAolJUVPRg==",
                                "contentType": "application/pdf"
                            }
                        ],
                        "effectiveDateTime": "2024-02-25T14:46:39.219042",
                        "code":
                        {
                            "coding":
                            []
                        }
                    }
                },
                {
                    "name": "labTestCollection",
                    "part":
                    [
                        {
                            "name": "labTest",
                            "resource":
                            {
                                "resourceType": "Observation",
                                "code":
                                {
                                    "text": "Hepatic Function Panel (7)",
                                    "coding":
                                    [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "24325-3",
                                            "display": "Hepatic Function Panel (7)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "status": "final"
                            }
                        },
                        {
                            "name": "labValue",
                            "resource":
                            {
                                "resourceType": "Observation",
                                "status": "final",
                                "code":
                                {
                                    "coding":
                                    [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "2885-2",
                                            "display": "Protein, Total"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity":
                                {
                                    "value": 9.6,
                                    "unit": "g/dL",
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange":
                                [
                                    {
                                        "low":
                                        {
                                            "value": 6.0
                                        },
                                        "high":
                                        {
                                            "value": 8.5
                                        },
                                        "text": "6.0-8.5"
                                    }
                                ],
                                "interpretation":
                                [
                                    {
                                        "text": "Abnormal",
                                        "coding":
                                        [
                                            {
                                                "code": "A",
                                                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                                                "display": "Abnormal"
                                            }
                                        ]
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource":
                            {
                                "resourceType": "Observation",
                                "status": "final",
                                "code":
                                {
                                    "coding":
                                    [
                                        {
                                            "code": "1751-7",
                                            "system": "http://loinc.org",
                                            "display": "Albumin"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity":
                                {
                                    "unit": "g/dL",
                                    "value": 3.8,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange":
                                [
                                    {
                                        "low":
                                        {
                                            "value": 3.6
                                        },
                                        "high":
                                        {
                                            "value": 4.6
                                        },
                                        "text": "3.6-4.6"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource":
                            {
                                "resourceType": "Observation",
                                "status": "final",
                                "code":
                                {
                                    "text": "Bilirubin, Total",
                                    "coding":
                                    [
                                        {
                                            "code": "1975-2",
                                            "system": "http://loinc.org",
                                            "display": "Bilirubin, Total"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity":
                                {
                                    "unit": "mg/dL",
                                    "value": 0.3,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange":
                                [
                                    {
                                        "low":
                                        {
                                            "value": 0.0
                                        },
                                        "high":
                                        {
                                            "value": 1.2
                                        },
                                        "text": "0.0-1.2"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource":
                            {
                                "resourceType": "Observation",
                                "status": "final",
                                "code":
                                {
                                    "text": "Alkaline Phosphatase",
                                    "coding":
                                    [
                                        {
                                            "code": "6768-6",
                                            "system": "http://loinc.org",
                                            "display": "Alkaline Phosphatase"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity":
                                {
                                    "unit": "IU/L",
                                    "value": 83.6,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange":
                                [
                                    {
                                        "low":
                                        {
                                            "value": 44.0
                                        },
                                        "high":
                                        {
                                            "value": 121.0
                                        },
                                        "text": "44-121"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource":
                            {
                                "resourceType": "Observation",
                                "status": "final",
                                "code":
                                {
                                    "text": "AST (SGOT)",
                                    "coding":
                                    [
                                        {
                                            "code": "1920-8",
                                            "system": "http://loinc.org",
                                            "display": "AST (SGOT)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity":
                                {
                                    "unit": "IU/L",
                                    "value": 19.4,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange":
                                [
                                    {
                                        "low":
                                        {
                                            "value": 0.0
                                        },
                                        "high":
                                        {
                                            "value": 40.0
                                        },
                                        "text": "0-40"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource":
                            {
                                "resourceType": "Observation",
                                "status": "final",
                                "code":
                                {
                                    "text": "ALT (SGPT)",
                                    "coding":
                                    [
                                        {
                                            "code": "1742-6",
                                            "system": "http://loinc.org",
                                            "display": "ALT (SGPT)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity":
                                {
                                    "unit": "IU/L",
                                    "value": 13.5,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange":
                                [
                                    {
                                        "low":
                                        {
                                            "value": 0.0
                                        },
                                        "high":
                                        {
                                            "value": 44.0
                                        },
                                        "text": "0-44"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DiagnosticReport/$create-lab-report"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Parameters",
            "parameter": [
                {
                    "name": "labReport",
                    "resource": {
                        "resourceType": "DiagnosticReport",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                                        "code": "LAB",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/4cc6fd69f81042a0b6d123e2080a7c1a",
                            "type": "Patient"
                        },
                        "presentedForm": [
                            {
                                "data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoVW50aXRsZWQgZG9jdW1lbnQpCi9Qcm9kdWNlciAoU2tpYS9QREYgbTEwNCBHb29nbGUgRG9jcyBSZW5kZXJlcik+PgplbmRvYmoKMyAwIG9iago8PC9jYSAxCi9CTSAvTm9ybWFsPj4KZW5kb2JqCjUgMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDE4Mj4+IHN0cmVhbQp4nHWQ0QrCMAxF3/MV+QG7pmmaFsQHQfes9A/UDYQ9OP8fbDfdQFhTmnIP9zaU0JbaUTk0ObwN8AKjMqm/XkTCWtcW58vYQ9My9m+oPFJAshJwfEAHl78EdXWXjK/jmKE5eyRvQl2KuQNapzBeUyTlhHmAqrFxquw5Yr7j3lrWA+YnqGEXUhAunhn4OIFoSIisxgVIWByRnKz6nOSNVUoqugDLG0B44wmvWyBN4JTLv3wAWrRKswplbmRzdHJlYW0KZW5kb2JqCjIgMCBvYmoKPDwvVHlwZSAvUGFnZQovUmVzb3VyY2VzIDw8L1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldCi9FeHRHU3RhdGUgPDwvRzMgMyAwIFI+PgovRm9udCA8PC9GNCA0IDAgUj4+Pj4KL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KL0NvbnRlbnRzIDUgMCBSCi9TdHJ1Y3RQYXJlbnRzIDAKL1BhcmVudCA2IDAgUj4+CmVuZG9iago2IDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9Db3VudCAxCi9LaWRzIFsyIDAgUl0+PgplbmRvYmoKNyAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyA2IDAgUj4+CmVuZG9iago4IDAgb2JqCjw8L0xlbmd0aDEgMTg0MjgKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA5MTQxPj4gc3RyZWFtCnic7XoJeFRF1vapureXdLqT29k76aRv0kkD6bAlYY+kQxbAiOyYYJAEiIRFWQIIihLGPaIwqKjoCO64dxLEgDowbqO4gIo6boCIiuMgyCgqSu7/VnWHBHC+n/H/vu9/fJ65N+etU1Xnnqp7zqlT1d0hRkSxAJV6DS0pLWOFLI+I7UVr/tBRI8deMWV9IpFiRf2uoWPHD7H92bIC/UHUe40c2zN3ccLTLiK+AfXqCSUjKkatnvk9Ud86IuctUy+qmctXsLvRfw76q6YuWqDf437/ayLzL6BxF86dftHrSyrXEjlGoX7x9Jr6uZREEdBfAHlt+uwlF046+GkrUdeuRFGD66ZdtPiF63+4ARPeRmTdUFdbM21v3MvQx+NIDIqGmLyIdDyPOVJm3UULFmd8yf9MZLoLbdWz50ytydqe/hbe5370N19Us3iuqcXRgD4xP/3imotqE6t7fwJjVKCtZO6c+gVGNq0BP1v0z51fOzfrvRFbidx4v0joJYWsxMlJzDDAC1tW0BEqoD+RBe0a9aQJ0PYYZE2oKyQvo4vQ+SsXnrcMbjuXijU69uSxSzXZctJVIVts1AO3qWZ+zRTSpy6ZP5v06fNrZ5FeVztlPumzaxZcTHqHTrKHeU7mcJsiZ9sPN6OhNBw4FjfDbM8DimdMrrWPttz61uTogu+tKVb52L2fdckW5WujBm069uTx6RpZheaITrPk0iZEcWFrxCGuhqGMknYyY1bj6EKaSwtoPSxGsj4N9XpRNz47cU897c0V5Tq2Cla0mtaaRISmhErlLbqQx1hNPNKscnGp4RmcuEaMPHckBTDSetM7baNZnmUwaw4Ih2F81Wd6Rs5CDdt1CFWRIi2aE7KotKV4C+E3A1K8E8868Rh1Vu18yHbGsP2FHIcFmCSNQnPsgXGTw77oJ30w3PhI1IDDjFSaAIKPUPvfvpb/1zdbxW9VRpx+q8PFbZ5p8UgtFpoookDFeqaZ1BDmGay8KMxzxEVdmFfgo65hXu0kY4KNosK8GRxREc2nGVRDs2kEomcC1aJej5Y5JKK+D+zam3qhf4RsmYNYW4IIq0XfcLoI7dMhezFQp+6gDm06jYHUdFoIvgatJ9c65B6GZC5G6I1bxG+d1H36aMWozQcvsAbtoRn2kGPODo83AyPUoa8+PHq9fJtFwGnUw9x5YQ34X4+C/9FL/QwW/H95vp7KQOWwS+wZyl97gicqxHOZpi3kAiWbHiKX6sPOQ8aXoAOibJthHBD9ouR/x0OtYSLaQI+zGfQ4baXn2WE89SRtpo30CiVSCd1FS+kWjGRG7L9C18OnYxDBJXQLcxkbsRvcg0i+h96A7Hl0BW2hBJZkfEXL6GrlHTx1NTkoA9ExCpFyIzvHWIhstEe9EtnhHETOXNZgVBg3GauN++kB2qy8YhynSKyOqbjfML4x/c34GBFdRbfSHbSHrY54CivqPKy7zcqfEFNrlUkqM6YbxzCDdLoEc1ARs2+wbdwP7bX0JUtiS5ViaLnPCBovQspNkxCba2kL68OG8nRTlTHCeIMSMMZiaL2DmmkT7lZ6jj5kdtNh437jMLkoB6tsGezxJtumtB1f3lYIi5lgpW40AD1z6M/0V9rJvOwvfI7Jbso1BUyXGruQKXvTeMz2ITz5BfuBX4F7mfKyWmYMwZq/mv4orE0v0acsmfVkI9kE3o3P4Xcr85FRc+RKnIa1dD3dDu27mZ9t4na+Q7lPfVT92ZzatteIgkd8dCf25b8wB95UZ/XsD+w99hkv5pP5nXyfcov6sPq2pQZvfQGyxI30KP3AYlh/Npqdz+rYUnYt+yO7g73BdrIDvIiP47P4IaVOmac8pw7BPVatV680XWO6wXygraLtxba32n4wco1raDTiYTlmfyvdjTfbTDvoA9x7aB8zsUgWhVtn6Ww8uwz3FexGdi/bwB5mGzHKTraPfcWOsO/ZzxyJkpt5Ck/nGbi9fD6/hN/C7+I7cO/k/+A/KYlKhuJX+igFSqUyB7O6VlmF+ynlUzVZ3aEasHOuaY1pnWmD6VHT86bDZrvlD1ayvv7Lfcezj+9uo7br2ta0NbdtND6lePgwGVbw4BQzGnmrBrl7Mc4rDyDO32F22C6ZZbPB7BxYZjKbyeaxxbDkVWwte0DO/Qn2LKz0PjuEOTu4W865B+/Dh/CRuC/gtXweX8VX8438PX5MsSiRSrQSr2QrQ5VJSq2yQFmirFGCyuvKJ8o+5ajyC25DtakeNUP1qX51qDpZXajerX6pfmmqMr1m+txsM19kvsbcav7W0tcy2DLKMtoyybLSssmyy1qN6HyBnqKnO+cBtldZrpQqT9FNPE918Tf5m4jnyTRNGcELxTmWXccvZxt5pmmxeRAfxM6lw6oPtn6Zr+NH+SBlBCtnY2km7x3SZo5TH0FRoL5AB9Vn8W5vQvNis51dwQ+Z7dTMZN5mLym9VL/yGn2o7GEW9R76SLWxRHaQP6SMQhQ8pw42VVC6chc9ocxjl9NTvBRHkZ+tKxDH57JHkBfGsVz2o4ITJj8XUdRP+YyupFn8b3QQ6/g6uo1NU6fTTZTHltKX9CBWRTfTxeZsczx7lc9QG3ks20hcfVjsISyTKaY4uopNUtaaD/EPsLvtUG20W3kMs9/Bn8Aeftg0htVhBVxO19A8YzktMVWob7PppLAJlKXuRXZbquSq6SiXIatUIadtwuregjxQpIxASxIi5xzExXhkiLW4b0eeUBFBM7DGz0MWe5M2msfxVppuimLIOsjGr7WNoYnGg3SHMZ0uNlZTd+SDa42l0LiBPqeVtIFd3XYZ9tE0rJzd7BxTGd9hKjO680b+AR/L15zsX1g7iyXR33E/gcpgnO8a1fdxti00VhjvIrq7IsPeQVPobNqPt/wGIwxTtlFe27m8yShT5uJ999Bo4yHDw2xUZ8ymkfQsPWAxUY3FDx8H2dt438uolo8xFii1bTNgh5WwQgDWWoj8c32gePy4okDh4LMKBg0c0L9fn/y83N69evbonuPP7ta1iy8r05uRrnvSUt0pya6kxIT4uNgYpxYd5bBH2iKsFrNJVTijnFJvWbUe9FUHVZ932LDuou6tQUNNp4bqoI6mspNlgnq1FNNPlgxA8sJTJAMhycAJSabpBVTQPUcv9erBN0q8eiubOLoC/I0l3ko9eFDyIyS/SvIO8OnpeEAvTaor0YOsWi8Nli2qayytLoG6pkhbsbe41tY9h5pskWAjwQUTvXObWOJgJhmeWDqwCSdjByYVTPaWlAZd3hIxg6CSVVozLThqdEVpSUp6emX3nCArnuqdEiTvkGC0X4pQsRwmaC4OWuQw+gzxNnSD3pSzrXFFq0ZTqv32ad5pNVUVQaWmUozh9GPckmDipfuTOqpQHlNccW3n3hSlsTRphi6qjY3X6sH1oys696YLrKyEDjzLs8qqG8sw9AoYsXysjtH41ZUVQXY1htTFm4i3Cr1frbdUtFTP1IMR3iHeusaZ1XBNcmOQxixJb05ODmw29lJyqd44rsKbHixM8VbWlLib4qhxzJIWV0B3ndzTPadJc4YM2xQVHWbsjs5M7Yk+yUlxwZWPOWFZJmbkHY6ACOpTdcykwot36i+gtj81Tu0PMVyVDE8Fp8EjM4IRxdWN2kDRLp4PmrI0r974PSECvAf/cXJLTbjFnKV9T4IVcXIi1NDfzgf9/mB2tggRSzF8ijkOlvU+3XMWtXKvd66mo4D5aBRsW1M5sCfMn54uHHxDa4CmoBJsGF0Rqus0JaWZAj39lUFeLXq2tffEjxc9De09Jx6v9iKSN8oTd3zQ6jvxF60lxJbWDQyyhP+iuzbUXz7WWz56YoVe2lgdtm35uJNqof7+J/rCXDC2uEJJ4WGOpyiyF0FZdUJYVCrsQTULf2YZ1NNaLVZEpWxhellQqx4WwkpbevoZPtRqHBZPyaLjsfA0gwP9J9cHnVQ/aXr2RgUTxlZZPm5iY6PtpD6EWmjA4eECEU/jKtL14iCNx8rMwl+rsa2/oMqUYAAmKxYCiL9QU7h6kmBKmK/EJaKze04ZEl1jY5lXL2usbqxpNRqmeHXN27iZP8+fb5xbWt0eOK3GlhtSgmUrKmGrOjYQi4LTkCYvu250U4BdN3ZixWaNSL9uXEUzZ7y4ekhlUyb6KjbrRAHZykWraBQVXVSonOElm7lVyqdsDhA1yF5VNsj61FZGss3a3sZoaisPtWntbRxtaqgtINvEJXJM8biKztEjl2Rld7nh4XMLVUVarad873GGl/nUulnt3GeGTntExG/TbTm1blE694maw2YjUunfv/5vuqEzOjLyt+mOOKVutXZogZlFTbPb/3t0R0SonfuEbqfDIT4z/XfoNnXuE7pjo6J+m277KfXIyI7IgZlt0BmvaafH02/SbT9JtxgpKSbmdJ+fyRV1at1h6dxnRy0lLk769d++tFPq0dEduqOhHjpTExJ+m+5Tv9XQtA4tGDcaNT0p6XSf/xbdTqetg4d66Ex3uX6b7vhT6jGddMOFTujMcrvFd63//pV46lhxHVowbgxq2bp+ejydyZV86liJjs7jxkFnD68XCes36HafOlZyR1RiXDFSrs93eqyeyeU5dSx3hxaM60Ktb7duMh7/7Sv9lHpaWoeWNKwb1Abm5Jy+Ds7kyjylrusdWnSsG9SKc3NPj9UzubqdUs/K6tCSRZSBWnn//qfH6plc3U+pZ2d3aMkm8qE2dvDg02P1TK78U+o9eiR18FAPnVWlpafH6plcp35/nJeX0sFDPXROKy8/PVbP5Bp8Sr1//9QOHrENnZtpnNK1xZfk2fms0o32grjSrdmf6tmsdFFSmwd5Aq2KtyUmPje6qLui42zUU6IOnAN6ErRVEb/TTFbSxG8owGWgBtCToK2gnSDsFEDRq4PmgNaB9ooeJVVxN+seraiL4sKzLpy1opVEOgQyQAp5gD1BI0GTQStB60BmKSda5oCWgbaCDsuegJLYvDoPc09svkEWLTNn58pqTahaNUlWW86rDJUjRofKkuEhsYEhsd75oeYeQ0Jll5xQGZOV2yBKmyN3W1GCkoCXTMDE5wIZf5GiGUMCWK/EUxDEFXO4JaDEtGT6ctdtVVRiClcYTSOPsU1hzQ5nbpGNG/wQkrGHf8MPhnr4wZYoZ+66orP5PnoStBWk8H24P+Wf0jK+V9gcWAhaB9oK2gE6BDLzvbj34N7Nd1M0/4R6ggpBk0HrQFtBh0AW/glQ4x+Lz1ESBV8I4vxjoMY/wmt9BIzmH4L7kH+Iqb3T3G9A7mbJ+HuGGU9WmElMCTMxCbmt/O3mn7ohonzwNCLqGSUDoZmnZDRn9fa0KknNBTM8rfyzFt3vWV/Ui++iIIhjJrsw8i7SQaNA1aC5IDO498C9Rw2gVaD1oCAIUQbUQDrfDnod9B71AgVAo0BWvrMZw7TyHc2+IZ6iBP4m/ytSgoe/wV+R5ev8ZVm+xl+S5aso01Bu5y83p3moKBL9hGc0lBrKnug38b+0ZMZ4jCIn3wrbeYA9QYWgkaDJoJUgM9/KM5qneWKg5BnajoOChzfTV7J8kO61UmCmJ+ArRgDqAnwDzwIHWKev8/GAb80dqArw3bQanADfVSvACfBduhycAN/sReAE+KbNBCfAN3EyOAG+kePAAVr53U9ndvH0GzmL6UXR/BJY6RJY6RJY6RJS+SXipp9UMbc7m7OzYbG1AX+3bE/DFtbwLGsYwxruZQ21rOEK1rCcNRSwhgtYg581uFlDGmsIsIZnWH+YooEFNp5UHRBIYg3bWcPjrKGeNfhYQxZryGQNOusXaOXpzcPzZFEqi5YisehQnjUY2Seap8Oi6Yj5dOSErcAdIEPWAhDSM0LCrjRRZrRkF4bqPQbmzikaxl/Agy/ADS/QHpAKB72AMHoBSl6AgmhgIWgyaBvoEMgAmSGdgYmvlBgN7AkqBE0GLQMdApnldA6BOM0JT/FJObGe4UmPFDX+Am7xQ0E6Tw+kam7Nrw1TVrpZdBobmWak8X4kzqQ4mFmdrcyx6QfHjz84KKIogt/EV1IqHLEqXK5s/inV08pub/Y94ymKZ7dRmoqoYwPIx7JQ9qd6We9Dbqso88nNH0WZ2+yegMeim305ni0sSjy1yfOTe7/nK3crB3vA/Yznfb1VZc2ed9Hy6CbPLvf1nld7tlrR8qyvlaHYokvRze7+nse3S9Hl6Fjb7LlCFJs8l7uHema5ZUdtqOOCetQC0Z4xvomeYdBX4p7iCdRD5yZPofsCT0FIqo94ZpOnF6bgD7HZmGw3txzUmyYVju/XyuoCOZY1lgrLSEtfS64lx5Ju8VhSLSmWOGuMVbNGWe1Wm9VqNVtVK7eSNa7V2Bvwi9/548zynzbEZ2hGquQ1TvLfBuS/AnBm5XQ2BWOVcl4+dggrD26bSuVT9ODRsd5WZhs9MWjyDmHBmHIqHzck2N9f3moxxgT7+cuDllHnVzQxdlMlWoP8ulZG4ypamSGark4R319uJsacV9+YIsquV99YWUlJCYsKkwpjBjsHlJX8ClSH0d9xJZ3EpwbXlI+tCD6SWhnMFYyRWlkevFl8wbmZHWGHS0s2s29FUVmxWRnMjpSOEe3K4JLKyvJWNkHKkc6+hRwi5lspZ8XGLORIt6aF5NaG5LLwPOQyRQG5iAjKknJZERFSTmVCrqk+s7SkKTNTyiTqVC9l6hP1zjLbsyCTlSVlEhpou5TZntAgZIKDpYjbDZE0txRhyeSWIm6WLEUmdIj0DItcf0LkejmSwjpk3CEZx952GcdeyPjP9Kod4vezlkGVU6vEl8PV3tJaUHXwhkV1ScGGKbreNLUy/K2xr3rK1DpR1tQGK721JcGp3hK9aVDVr3RXie5B3pImnBfHVTRVBWpLmgcFBpV6a0oqW4aOyu930ljXnxgrf9SvKBsllOWLsYb2+5XufqJ7qBirnxirnxhraGCoHItkjI+qaLLSkMriqlDZwiNtiNfqlPTKIQna3MEyeAelJ12RsgWnlQ0U6a8M2r1Dgg6Q6Ope1L1IdGFNia4o8QtAuCvpikHpKVvYhnCXhmandwj5FyysX0hJpTNKQn/1uNC0YKEweAj99f/qQl9pMFBTUr8AnxKC2WPLg4WjJ1Y0WSxorRavFBzY3hYZWdpqbAs19kDjQNGoKCcERVuBaIuICAue7v+F4bJYrIIG/kwLC6SxBVRfqQTTysdxpIJx4a9at+AsJbaH+kq8YD3zs/p2HeFp+/0UqpN453ZasDDMhW2xIFyGnsQj9e0mOXEJY/lPWGwBFIrk1YtI3WLaQhbaHXCZud0+ZLxFotkSGQleIms1ftooGAITcArObLI70C0R3T9vFAy6fw44BWfiaarCSf74FdHK61t0lanIx0+bdcZ7KkwB/xRj4tNAq3EgEKlpfDxZo6O50HFko90umX0bHQ7J/IIWs2Da0CIYaLRuuiPJrx0NvdykAu070PH9k77QCrQCKiwsOF7QuxfreP10Z3qf9Ph0J49tS1Ub21JMjscfP/ZPpPAy44CyBxZwUirbGlhq46ojy5HvKHGY+sT1cZ/Hx9nGxI11T+fTTLURU+Oq3ds8u0zvxn7i+jz287hDiV+7Pk/d6zE8CR6PP7kgoSC5PHmuZ5XH0oNnOnokDOR9HOW81FEWN9x9nm2CY7rjc/OXCcfYd1Eai1eiIrVoSnFHWpxki3crkUmtxo94vyHjBfO0cEJSnrDPkael7bOc0e0CYL7bKATAHAl0Ed3RWZq208k0Z8BZ7Wxwqp5AZCQf7wkICzpjhH2deCjgFDZ2mqOigEmyT2iIjIw0j3dGaZpZ1L+R1naGBgsxgWoxmnNBjFUMH2MXtZgoMW5MpkWTUaOJnq2WHZY9FsOieiyF2GcVS5qYhSVJONSSJsaz2MVYFrvQbEkWA1lcafmjkvznat+FfTnP7x9xEMzxTtE7aV6BJtq04/6C/YjdwoOFBYKcA5wxA3r3okls3iSal97H7M3w+frkx/TNy01IdOY5WVxCXm7fPvk+b4ZZ6V/74rJ3F87cdWX1mp4tx/XHFi56YMNli++55u4VP9+3jimNo4t41LEyHvP69r+8/OHrL4r/fCw3Dqhp6mCKR3TcHUj0kDuej1cmmSZFjI+sVWaZ5kTURlrjW4397abaHxgjuFS3wC4xH5iOxR1NVnvHDHT1dhfFjEguco+OqXKNcdfEXJRc415sXhx/lB9N0iiBRTsSE0clVCfMxUdCd/Qqbb3GNU1NcdsstIU/QszYtlG4EattW0C6SmOM3RrrViMTW43DMhwSxeIRXgHz4ybhkMSAo9X4WK4jh/CsmBWYv0sXO4SqiC7Z+UEHcyR7UGvJ8uWL8uk0b34vD/MkYO0FqoSihDzNKobQpNc1GQdapiWQmZ3f7msZFcKzQL2T393S71HS727p8QTpffi9Xye/w8n+EcLn+9GGGDg6T7TJSIC7j09CR+HBmAE9JxUcn1fA4PYBwvNsEqHHz+bNZ4lmeJ+cGuXlkjPOkp4gXM/SfV2k8y/YkvPN5q/aDrG4j99lUeyXA7bmq6euOP4hH23vP+H6pQ+zCYn3bWQepjA769q2u+0nTX9ySx279ZriugdFpoxFODSY3qFE1i2QFhfBol09Xb1cAddc1532uxwPO6zJjq6OoGubS3UJswaSPfmpVodij3bbWDz3x8Wq+CRvWxfH4oxYacPYgJoomURpzERpvsQsFYf91Uys+20tvfvnizLgd3vyVxFzBcTqdQUcWL0UJ3NmV5kzM8R6ppxwtsR6lgk0TlichLNFtID5YmN0tGSOPS3z6X1JrmfZFkqno8xGOCYe7bzg/H7kVORSueoO+g9OEkm1AGm18OAAJwxfvCQQpznNERaz1czNWkRMCjnN0SnYwvzZy5czP9bj/Dynt09en/x+fbEcEy3CDfHxefFeZ/O6dbHJVy46pyqlf+6Ykh07lLUr5s3KLzsv5k+2suopK365ECvv2rYZajpWXgylsTWBBXatu3aWVq6phXpQ5x69m92bmhufmzokda6+SrcOTByYcnbi2SmV1vPtVYlVKTOts+wztIsSZ6Vs09+J+yTpk+R30vbH7U/bqxt6glf1a/74PupArUw9W5uofR75dWqbFumMwsJzmy3MnOCOiqQoV/tqcrWnW5dIhR7hLVfmThvTbAFbta3Bpuoy2eoy2dpg50CkcIstKVw/Jjc0m1h/wiU2oU54wib2vj7CFbYFLDaP54XTayixhpJsFtE2xlax9SzIDjPVwwrZSMSoWJepwutME4MwTYzANDENJjMsJI5Kv0vRBDEcs4uhWIxYfMzlGdoviXVefcix8wtGaGIFfrdfO97RGlqByLaFB50DwtkWsjQv1pkXL1ybkBAfx0Xm7eJUOuXba+8fuLruup0zF+65bOLKHs4HFy1+9KEF9U1tM0zPNY4evcK4/b62n284Z+Dxn5X733jxtXdf2/6+WGeF2I+b4PdeSlMgNrRAkiS6JHZt90WXdsbXzmS1M5ntjLedyWhn0tsZXeyGywSnZsRlDIw4O6Ikc0JGbcbSiJsirsp8MPbRnOcVR0RiclJir/Kc9xJNKXw851ousyVVWasiqmxVkVX2KsdM68yImbaZkTPtMx0bfRu7RHfxZXbJ7NY3c6KtMnKab1rXBd4FmQ2ZN9vusq/uelvOrb3utz1sv6/L/V1bfC/5EuS7CG9ktDPediaznQm/r7n9FcztL2Vuf01sNq3G7kBM2oCJ1i5ZdpuarPvi1cgeqcmt/JFAhitHHgRcha6RrsmuJ107XOZol8c1x7XHpXpcK13c9RxyRTyym9xjAnFCXGMBxjW2k3FiGuNiz2mJS8iXe48W5cxnrEdV6uxUnuqOt6hiGuIhVWQYEXKCCcSKkFPdPSI9ySw50xWITcrPFY/3kTksKYQidl0JInZdunjSpYunXJp4K5fcJUQvfL+Fn08W48gmeSjNzIaip9wDdmazbDGmeB7MgY1CqWTE89ki8wkVYL7bJLRkJ8sZpGPHq87dlssLcxtyea7YRjNJToU0ebzUQ8bnMkjkG8lo8Yi56TIK9cxoudai5dyjdSGMs9ixgE9MITpKjB8tzzjRZnlOy9hDrJBGIq+5eod3vUnzRrSvPbHCkJL8B+efq+H4E8rD88Te17E60YltEGXhwXnYBeVy9WOdygK7If6wKSaGMnOgS/c0rykux+fUYrRYTTFnOPQUiuhqSWGm7oC0OFTTo7wplOF12K3dbCmsa5cIm9mvppBHS01h+NAhDtIhkMfobP/y5cupU7Jgk+Yjx59oEEKx/RJCy7+Lr0sP3ie/b79QekDul8k/LjEBdxqPjxNbta+wOfr6y5Yu7pN188t3jCzqn/3HsZc/N9EZtNfPWDozIaFnylVbb5sw4+XLd3zAznLPml9bcpY3KSt3+PJzhy7p6vEPu2x60piqMf287tRYW2Ze0dKqievOe0xkkEzjCM823YGd2rOZ7PjMIDwQ2RpmrO2MpZ0xtzM2EeZeX36EiJKxYBpcjJjdYWMKJWgR/mgbdgYlMlrLoAzmOClZ20LJ2s4Mi7U0orTaMtfSYFllUcmiW9ZbgpZtlp0Ws0XsAGLbtoR2AMkc2SjSuCV02g4z8tgk9g0Re2AOiw0FnFmenkSAywPUFj6Tkljfpgs7PghJzyB9HywQCbxA2/9dgTwrHy8QqduZl6e9Ks5MYdGsxNB5WWzTzn5OsTXHCQ9yLfmcgimzc666quWpp2L9XdPuWacNrr2XT13BLLPbblxx/OYROaHfqxRSmLhMioI0wSjJ9I/IbfSj1SArWY02iqAI4zjZyCb/rz0SaIdLjpODHMAoidEUBdQoGugE/oI93wmMpRhgHMUC44E/UwLFARMpHpgEPEYuSgSfTC7wKZQMdEtMpRRgGrmNn8gjUadUYDp5gBmkA73AHymT0oFZlAH0AX+gLuQFdkUc/UDdyAfMluinLsZRyqGuwO4Se1A2sCf5gb2oO7A38HvKpR7APOoJzKdexnfUR2Jf6g3sR3nA/pRv/JMGSBxIfYCDJBZQX+BZ1A84mPoDC2mAcYQCNBBYRIOAQ6gAWAz8lkroLGApDQaWYfc8TEMpABxGRcDhNAR4tsRyKgaeQyXAEfjce4jOlTiShgJH0TDgaBpufENjJI6ls4Hj8BnoII2nEcAJEs+jc4EVNNL4B1XSKOBE4EE6n0aDr6KxwEk0DniBxMk03viaqmkCsIbOA04B/p2mUiVwGk0E1tL5wAupyviKpkuso0nAGXSBcYBmUjX4WRJnUw3wIpqC9otpKnCOxLk0zfiS5lEtcD5NB9ZLXEB1xhe0kGYAF9FM4CXAz2kxzQIuoYuAl9LFwMskLqU5wMtpLvAKmmfsp2USG6geuJwWAP9ACw3x/9qLgFdJvJouMfbRNbQYeC0tAV5HlwKvp8uMT6mRlgJvoMvRsgL4Kd1IVwBvomXAlbQcuAq4l/5IfwCupiuBN9NVxh66ReKtdDVwDV0LvI2uQ+/twD10B10PXEuNxm66k24A3kUrgH+SeDfdBFxHK4HraRXwHuAndC/9EXgfrQbeTzcDH6BbjI/pQbrV+IgeojXADXQb8GGJj9DtwEfpDuBjdCfwcYlP0F3AJ+lPwCDdDWwCfkjNtA7YQuuBG+le4wN6iu4z/kabJD5N9wNb6QHgZnoQuEXiM7QB+Cw9bLxPz9EjwD9L3EqPArfRY8C/0OPA5+kJ4Av0pPEevUhB4EvUZLxLL0v8KzUDX6EWYxe9ShuB2+kp4Gu0Cfg6PQ18A5+CdtGbtBm4Q+JO2gJ8i54Fvk3PGe/QO8C3aRf9GfgubQW+R9uMt+h9iX+j54Ef0AvAD+lF4EcSP6aXgJ/Qy8Dd9FdjJ+2RuJdeNXbQp7QduI9eA34mcT+9Dvyc3gB+QW8Cv6Sdxpt0QOJX9Bbw7/S28QZ9Te8A/yHxIO0CfkPvGa/TIXofeFjit/Q34BH6APhP+hD4ncTv6WPjNTpKnwB/oN3AH4Hb6SfaAzxGe4E/06fAXyQep8+MV6mN9gMN+hz4n5z+P5/Tv/2d5/Svzzinf/UvcvpXp+X0A/8ip395Wk7/4gxy+v4TOX3+STn9s3+R0z+TOf2z03L6PpnT93XK6ftkTt8nc/q+Tjn909Ny+l6Z0/fKnL73d5jTP/j/lNN3/Sen/yen/+5y+u/9nP77zen/6pz+n5z+n5z+6zn9ld9/Tv8/7yjp0QplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9BQUFBQUErQXJpYWxNVAovRmxhZ3MgNAovQXNjZW50IDkwNS4yNzM0NAovRGVzY2VudCAtMjExLjkxNDA2Ci9TdGVtViA0NS44OTg0MzgKL0NhcEhlaWdodCA3MTUuODIwMzEKL0l0YWxpY0FuZ2xlIDAKL0ZvbnRCQm94IFstNjY0LjU1MDc4IC0zMjQuNzA3MDMgMjAwMCAxMDA1Ljg1OTM4XQovRm9udEZpbGUyIDggMCBSPj4KZW5kb2JqCjEwIDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0ZvbnREZXNjcmlwdG9yIDkgMCBSCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL1N1YnR5cGUgL0NJREZvbnRUeXBlMgovQ0lEVG9HSURNYXAgL0lkZW50aXR5Ci9DSURTeXN0ZW1JbmZvIDw8L1JlZ2lzdHJ5IChBZG9iZSkKL09yZGVyaW5nIChJZGVudGl0eSkKL1N1cHBsZW1lbnQgMD4+Ci9XIFswIFs3NTAgMCAwIDI3Ny44MzIwM10gNTUgWzYxMC44Mzk4NF0gNzEgNzIgNTU2LjE1MjM0IDczIFsyNzcuODMyMDNdIDgzIFs1NTYuMTUyMzQgMCAwIDUwMCAyNzcuODMyMDNdXQovRFcgMD4+CmVuZG9iagoxMSAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMjYyPj4gc3RyZWFtCnicXZHNasQgFIX3PsVdTheDTpKZoRACZUohi/7QtA9g9CYVGhVjFnn7+pOmUEHlcO539Cq9tY+tVh7omzOiQw+D0tLhbBYnEHoclSanAqQSflNpFRO3hAa4W2ePU6sHQ+oagL4Hd/ZuhcODND3eEfrqJDqlRzh83rqgu8Xab5xQe2CkaUDiEJKeuX3hEwJN2LGVwVd+PQbmr+JjtQhF0qd8G2EkzpYLdFyPSGoWRgP1UxgNQS3/+WWm+kF8cZeqy1DNWMGaqMprUucqqXP2riwlbUzxm7AfWGWouk/bZWMvOSl713KLyFC8V3y/vWmxOBf6TY+cGo0tKo37P1hjIxXnDxIJhhgKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUwCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL0VuY29kaW5nIC9JZGVudGl0eS1ICi9EZXNjZW5kYW50Rm9udHMgWzEwIDAgUl0KL1RvVW5pY29kZSAxMSAwIFI+PgplbmRvYmoKeHJlZgowIDEyCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxNSAwMDAwMCBuIAowMDAwMDAwMzk3IDAwMDAwIG4gCjAwMDAwMDAxMDggMDAwMDAgbiAKMDAwMDAxMDgxMSAwMDAwMCBuIAowMDAwMDAwMTQ1IDAwMDAwIG4gCjAwMDAwMDA2MDUgMDAwMDAgbiAKMDAwMDAwMDY2MCAwMDAwMCBuIAowMDAwMDAwNzA3IDAwMDAwIG4gCjAwMDAwMDk5MzQgMDAwMDAgbiAKMDAwMDAxMDE2OCAwMDAwMCBuIAowMDAwMDEwNDc4IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxMgovUm9vdCA3IDAgUgovSW5mbyAxIDAgUj4+CnN0YXJ0eHJlZgoxMDk1MAolJUVPRg==",
                                "contentType": "application/pdf"
                            }
                        ],
                        "effectiveDateTime": "2024-02-25T14:46:39.219042",
                        "code": {
                            "coding": []
                        }
                    }
                },
                {
                    "name": "labTestCollection",
                    "part": [
                        {
                            "name": "labTest",
                            "resource": {
                                "resourceType": "Observation",
                                "code": {
                                    "text": "Hepatic Function Panel (7)",
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "24325-3",
                                            "display": "Hepatic Function Panel (7)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "status": "final"
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "2885-2",
                                            "display": "Protein, Total"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "value": 9.6,
                                    "unit": "g/dL",
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 6.0
                                        },
                                        "high": {
                                            "value": 8.5
                                        },
                                        "text": "6.0-8.5"
                                    }
                                ],
                                "interpretation": [
                                    {
                                        "text": "Abnormal",
                                        "coding": [
                                            {
                                                "code": "A",
                                                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                                                "display": "Abnormal"
                                            }
                                        ]
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "coding": [
                                        {
                                            "code": "1751-7",
                                            "system": "http://loinc.org",
                                            "display": "Albumin"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "g/dL",
                                    "value": 3.8,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 3.6
                                        },
                                        "high": {
                                            "value": 4.6
                                        },
                                        "text": "3.6-4.6"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "Bilirubin, Total",
                                    "coding": [
                                        {
                                            "code": "1975-2",
                                            "system": "http://loinc.org",
                                            "display": "Bilirubin, Total"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "mg/dL",
                                    "value": 0.3,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 0.0
                                        },
                                        "high": {
                                            "value": 1.2
                                        },
                                        "text": "0.0-1.2"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "Alkaline Phosphatase",
                                    "coding": [
                                        {
                                            "code": "6768-6",
                                            "system": "http://loinc.org",
                                            "display": "Alkaline Phosphatase"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "IU/L",
                                    "value": 83.6,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 44.0
                                        },
                                        "high": {
                                            "value": 121.0
                                        },
                                        "text": "44-121"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "AST (SGOT)",
                                    "coding": [
                                        {
                                            "code": "1920-8",
                                            "system": "http://loinc.org",
                                            "display": "AST (SGOT)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "IU/L",
                                    "value": 19.4,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 0.0
                                        },
                                        "high": {
                                            "value": 40.0
                                        },
                                        "text": "0-40"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "ALT (SGPT)",
                                    "coding": [
                                        {
                                            "code": "1742-6",
                                            "system": "http://loinc.org",
                                            "display": "ALT (SGPT)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "IU/L",
                                    "value": 13.5,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 0.0
                                        },
                                        "high": {
                                            "value": 44.0
                                        },
                                        "text": "0-44"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
###  Response 
A successful request returns `201 Created` with a `Parameters` resource containing a `valueReference` to the newly created `DiagnosticReport`:
    ```json
    {
        "resourceType": "Parameters",
        "parameter": [
            {
                "name": "return",
                "valueReference": {
                    "reference": "DiagnosticReport/9b90621b-059f-4f6e-9ef5-58171098e424"
                }
            }
        ]
    }
    ```
Standard error responses (`400 Bad Request`, `401 Unauthorized`, `403 Forbidden`) follow the FHIR `OperationOutcome` shape described in [Errors](/api/errors).
###  Additional JSON Examples 
  - **More than one lab test**
        ```json
        {
            "resourceType": "Parameters",
            "parameter": [
                {
                    "name": "labReport",
                    "resource": {
                        "resourceType": "DiagnosticReport",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                                        "code": "LAB",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/4cc6fd69f81042a0b6d123e2080a7c1a",
                            "type": "Patient"
                        },
                        "presentedForm": [
                            {
                                "data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoVW50aXRsZWQgZG9jdW1lbnQpCi9Qcm9kdWNlciAoU2tpYS9QREYgbTEwNCBHb29nbGUgRG9jcyBSZW5kZXJlcik+PgplbmRvYmoKMyAwIG9iago8PC9jYSAxCi9CTSAvTm9ybWFsPj4KZW5kb2JqCjUgMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDE4Mj4+IHN0cmVhbQp4nHWQ0QrCMAxF3/MV+QG7pmmaFsQHQfes9A/UDYQ9OP8fbDfdQFhTmnIP9zaU0JbaUTk0ObwN8AKjMqm/XkTCWtcW58vYQ9My9m+oPFJAshJwfEAHl78EdXWXjK/jmKE5eyRvQl2KuQNapzBeUyTlhHmAqrFxquw5Yr7j3lrWA+YnqGEXUhAunhn4OIFoSIisxgVIWByRnKz6nOSNVUoqugDLG0B44wmvWyBN4JTLv3wAWrRKswplbmRzdHJlYW0KZW5kb2JqCjIgMCBvYmoKPDwvVHlwZSAvUGFnZQovUmVzb3VyY2VzIDw8L1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldCi9FeHRHU3RhdGUgPDwvRzMgMyAwIFI+PgovRm9udCA8PC9GNCA0IDAgUj4+Pj4KL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KL0NvbnRlbnRzIDUgMCBSCi9TdHJ1Y3RQYXJlbnRzIDAKL1BhcmVudCA2IDAgUj4+CmVuZG9iago2IDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9Db3VudCAxCi9LaWRzIFsyIDAgUl0+PgplbmRvYmoKNyAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyA2IDAgUj4+CmVuZG9iago4IDAgb2JqCjw8L0xlbmd0aDEgMTg0MjgKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA5MTQxPj4gc3RyZWFtCnic7XoJeFRF1vapureXdLqT29k76aRv0kkD6bAlYY+kQxbAiOyYYJAEiIRFWQIIihLGPaIwqKjoCO64dxLEgDowbqO4gIo6boCIiuMgyCgqSu7/VnWHBHC+n/H/vu9/fJ65N+etU1Xnnqp7zqlT1d0hRkSxAJV6DS0pLWOFLI+I7UVr/tBRI8deMWV9IpFiRf2uoWPHD7H92bIC/UHUe40c2zN3ccLTLiK+AfXqCSUjKkatnvk9Ud86IuctUy+qmctXsLvRfw76q6YuWqDf437/ayLzL6BxF86dftHrSyrXEjlGoX7x9Jr6uZREEdBfAHlt+uwlF046+GkrUdeuRFGD66ZdtPiF63+4ARPeRmTdUFdbM21v3MvQx+NIDIqGmLyIdDyPOVJm3UULFmd8yf9MZLoLbdWz50ytydqe/hbe5370N19Us3iuqcXRgD4xP/3imotqE6t7fwJjVKCtZO6c+gVGNq0BP1v0z51fOzfrvRFbidx4v0joJYWsxMlJzDDAC1tW0BEqoD+RBe0a9aQJ0PYYZE2oKyQvo4vQ+SsXnrcMbjuXijU69uSxSzXZctJVIVts1AO3qWZ+zRTSpy6ZP5v06fNrZ5FeVztlPumzaxZcTHqHTrKHeU7mcJsiZ9sPN6OhNBw4FjfDbM8DimdMrrWPttz61uTogu+tKVb52L2fdckW5WujBm069uTx6RpZheaITrPk0iZEcWFrxCGuhqGMknYyY1bj6EKaSwtoPSxGsj4N9XpRNz47cU897c0V5Tq2Cla0mtaaRISmhErlLbqQx1hNPNKscnGp4RmcuEaMPHckBTDSetM7baNZnmUwaw4Ih2F81Wd6Rs5CDdt1CFWRIi2aE7KotKV4C+E3A1K8E8868Rh1Vu18yHbGsP2FHIcFmCSNQnPsgXGTw77oJ30w3PhI1IDDjFSaAIKPUPvfvpb/1zdbxW9VRpx+q8PFbZ5p8UgtFpoookDFeqaZ1BDmGay8KMxzxEVdmFfgo65hXu0kY4KNosK8GRxREc2nGVRDs2kEomcC1aJej5Y5JKK+D+zam3qhf4RsmYNYW4IIq0XfcLoI7dMhezFQp+6gDm06jYHUdFoIvgatJ9c65B6GZC5G6I1bxG+d1H36aMWozQcvsAbtoRn2kGPODo83AyPUoa8+PHq9fJtFwGnUw9x5YQ34X4+C/9FL/QwW/H95vp7KQOWwS+wZyl97gicqxHOZpi3kAiWbHiKX6sPOQ8aXoAOibJthHBD9ouR/x0OtYSLaQI+zGfQ4baXn2WE89SRtpo30CiVSCd1FS+kWjGRG7L9C18OnYxDBJXQLcxkbsRvcg0i+h96A7Hl0BW2hBJZkfEXL6GrlHTx1NTkoA9ExCpFyIzvHWIhstEe9EtnhHETOXNZgVBg3GauN++kB2qy8YhynSKyOqbjfML4x/c34GBFdRbfSHbSHrY54CivqPKy7zcqfEFNrlUkqM6YbxzCDdLoEc1ARs2+wbdwP7bX0JUtiS5ViaLnPCBovQspNkxCba2kL68OG8nRTlTHCeIMSMMZiaL2DmmkT7lZ6jj5kdtNh437jMLkoB6tsGezxJtumtB1f3lYIi5lgpW40AD1z6M/0V9rJvOwvfI7Jbso1BUyXGruQKXvTeMz2ITz5BfuBX4F7mfKyWmYMwZq/mv4orE0v0acsmfVkI9kE3o3P4Xcr85FRc+RKnIa1dD3dDu27mZ9t4na+Q7lPfVT92ZzatteIgkd8dCf25b8wB95UZ/XsD+w99hkv5pP5nXyfcov6sPq2pQZvfQGyxI30KP3AYlh/Npqdz+rYUnYt+yO7g73BdrIDvIiP47P4IaVOmac8pw7BPVatV680XWO6wXygraLtxba32n4wco1raDTiYTlmfyvdjTfbTDvoA9x7aB8zsUgWhVtn6Ww8uwz3FexGdi/bwB5mGzHKTraPfcWOsO/ZzxyJkpt5Ck/nGbi9fD6/hN/C7+I7cO/k/+A/KYlKhuJX+igFSqUyB7O6VlmF+ynlUzVZ3aEasHOuaY1pnWmD6VHT86bDZrvlD1ayvv7Lfcezj+9uo7br2ta0NbdtND6lePgwGVbw4BQzGnmrBrl7Mc4rDyDO32F22C6ZZbPB7BxYZjKbyeaxxbDkVWwte0DO/Qn2LKz0PjuEOTu4W865B+/Dh/CRuC/gtXweX8VX8438PX5MsSiRSrQSr2QrQ5VJSq2yQFmirFGCyuvKJ8o+5ajyC25DtakeNUP1qX51qDpZXajerX6pfmmqMr1m+txsM19kvsbcav7W0tcy2DLKMtoyybLSssmyy1qN6HyBnqKnO+cBtldZrpQqT9FNPE918Tf5m4jnyTRNGcELxTmWXccvZxt5pmmxeRAfxM6lw6oPtn6Zr+NH+SBlBCtnY2km7x3SZo5TH0FRoL5AB9Vn8W5vQvNis51dwQ+Z7dTMZN5mLym9VL/yGn2o7GEW9R76SLWxRHaQP6SMQhQ8pw42VVC6chc9ocxjl9NTvBRHkZ+tKxDH57JHkBfGsVz2o4ITJj8XUdRP+YyupFn8b3QQ6/g6uo1NU6fTTZTHltKX9CBWRTfTxeZsczx7lc9QG3ks20hcfVjsISyTKaY4uopNUtaaD/EPsLvtUG20W3kMs9/Bn8Aeftg0htVhBVxO19A8YzktMVWob7PppLAJlKXuRXZbquSq6SiXIatUIadtwuregjxQpIxASxIi5xzExXhkiLW4b0eeUBFBM7DGz0MWe5M2msfxVppuimLIOsjGr7WNoYnGg3SHMZ0uNlZTd+SDa42l0LiBPqeVtIFd3XYZ9tE0rJzd7BxTGd9hKjO680b+AR/L15zsX1g7iyXR33E/gcpgnO8a1fdxti00VhjvIrq7IsPeQVPobNqPt/wGIwxTtlFe27m8yShT5uJ999Bo4yHDw2xUZ8ymkfQsPWAxUY3FDx8H2dt438uolo8xFii1bTNgh5WwQgDWWoj8c32gePy4okDh4LMKBg0c0L9fn/y83N69evbonuPP7ta1iy8r05uRrnvSUt0pya6kxIT4uNgYpxYd5bBH2iKsFrNJVTijnFJvWbUe9FUHVZ932LDuou6tQUNNp4bqoI6mspNlgnq1FNNPlgxA8sJTJAMhycAJSabpBVTQPUcv9erBN0q8eiubOLoC/I0l3ko9eFDyIyS/SvIO8OnpeEAvTaor0YOsWi8Nli2qayytLoG6pkhbsbe41tY9h5pskWAjwQUTvXObWOJgJhmeWDqwCSdjByYVTPaWlAZd3hIxg6CSVVozLThqdEVpSUp6emX3nCArnuqdEiTvkGC0X4pQsRwmaC4OWuQw+gzxNnSD3pSzrXFFq0ZTqv32ad5pNVUVQaWmUozh9GPckmDipfuTOqpQHlNccW3n3hSlsTRphi6qjY3X6sH1oys696YLrKyEDjzLs8qqG8sw9AoYsXysjtH41ZUVQXY1htTFm4i3Cr1frbdUtFTP1IMR3iHeusaZ1XBNcmOQxixJb05ODmw29lJyqd44rsKbHixM8VbWlLib4qhxzJIWV0B3ndzTPadJc4YM2xQVHWbsjs5M7Yk+yUlxwZWPOWFZJmbkHY6ACOpTdcykwot36i+gtj81Tu0PMVyVDE8Fp8EjM4IRxdWN2kDRLp4PmrI0r974PSECvAf/cXJLTbjFnKV9T4IVcXIi1NDfzgf9/mB2tggRSzF8ijkOlvU+3XMWtXKvd66mo4D5aBRsW1M5sCfMn54uHHxDa4CmoBJsGF0Rqus0JaWZAj39lUFeLXq2tffEjxc9De09Jx6v9iKSN8oTd3zQ6jvxF60lxJbWDQyyhP+iuzbUXz7WWz56YoVe2lgdtm35uJNqof7+J/rCXDC2uEJJ4WGOpyiyF0FZdUJYVCrsQTULf2YZ1NNaLVZEpWxhellQqx4WwkpbevoZPtRqHBZPyaLjsfA0gwP9J9cHnVQ/aXr2RgUTxlZZPm5iY6PtpD6EWmjA4eECEU/jKtL14iCNx8rMwl+rsa2/oMqUYAAmKxYCiL9QU7h6kmBKmK/EJaKze04ZEl1jY5lXL2usbqxpNRqmeHXN27iZP8+fb5xbWt0eOK3GlhtSgmUrKmGrOjYQi4LTkCYvu250U4BdN3ZixWaNSL9uXEUzZ7y4ekhlUyb6KjbrRAHZykWraBQVXVSonOElm7lVyqdsDhA1yF5VNsj61FZGss3a3sZoaisPtWntbRxtaqgtINvEJXJM8biKztEjl2Rld7nh4XMLVUVarad873GGl/nUulnt3GeGTntExG/TbTm1blE694maw2YjUunfv/5vuqEzOjLyt+mOOKVutXZogZlFTbPb/3t0R0SonfuEbqfDIT4z/XfoNnXuE7pjo6J+m277KfXIyI7IgZlt0BmvaafH02/SbT9JtxgpKSbmdJ+fyRV1at1h6dxnRy0lLk769d++tFPq0dEduqOhHjpTExJ+m+5Tv9XQtA4tGDcaNT0p6XSf/xbdTqetg4d66Ex3uX6b7vhT6jGddMOFTujMcrvFd63//pV46lhxHVowbgxq2bp+ejydyZV86liJjs7jxkFnD68XCes36HafOlZyR1RiXDFSrs93eqyeyeU5dSx3hxaM60Ktb7duMh7/7Sv9lHpaWoeWNKwb1Abm5Jy+Ds7kyjylrusdWnSsG9SKc3NPj9UzubqdUs/K6tCSRZSBWnn//qfH6plc3U+pZ2d3aMkm8qE2dvDg02P1TK78U+o9eiR18FAPnVWlpafH6plcp35/nJeX0sFDPXROKy8/PVbP5Bp8Sr1//9QOHrENnZtpnNK1xZfk2fms0o32grjSrdmf6tmsdFFSmwd5Aq2KtyUmPje6qLui42zUU6IOnAN6ErRVEb/TTFbSxG8owGWgBtCToK2gnSDsFEDRq4PmgNaB9ooeJVVxN+seraiL4sKzLpy1opVEOgQyQAp5gD1BI0GTQStB60BmKSda5oCWgbaCDsuegJLYvDoPc09svkEWLTNn58pqTahaNUlWW86rDJUjRofKkuEhsYEhsd75oeYeQ0Jll5xQGZOV2yBKmyN3W1GCkoCXTMDE5wIZf5GiGUMCWK/EUxDEFXO4JaDEtGT6ctdtVVRiClcYTSOPsU1hzQ5nbpGNG/wQkrGHf8MPhnr4wZYoZ+66orP5PnoStBWk8H24P+Wf0jK+V9gcWAhaB9oK2gE6BDLzvbj34N7Nd1M0/4R6ggpBk0HrQFtBh0AW/glQ4x+Lz1ESBV8I4vxjoMY/wmt9BIzmH4L7kH+Iqb3T3G9A7mbJ+HuGGU9WmElMCTMxCbmt/O3mn7ohonzwNCLqGSUDoZmnZDRn9fa0KknNBTM8rfyzFt3vWV/Ui++iIIhjJrsw8i7SQaNA1aC5IDO498C9Rw2gVaD1oCAIUQbUQDrfDnod9B71AgVAo0BWvrMZw7TyHc2+IZ6iBP4m/ytSgoe/wV+R5ev8ZVm+xl+S5aso01Bu5y83p3moKBL9hGc0lBrKnug38b+0ZMZ4jCIn3wrbeYA9QYWgkaDJoJUgM9/KM5qneWKg5BnajoOChzfTV7J8kO61UmCmJ+ArRgDqAnwDzwIHWKev8/GAb80dqArw3bQanADfVSvACfBduhycAN/sReAE+KbNBCfAN3EyOAG+kePAAVr53U9ndvH0GzmL6UXR/BJY6RJY6RJY6RJS+SXipp9UMbc7m7OzYbG1AX+3bE/DFtbwLGsYwxruZQ21rOEK1rCcNRSwhgtYg581uFlDGmsIsIZnWH+YooEFNp5UHRBIYg3bWcPjrKGeNfhYQxZryGQNOusXaOXpzcPzZFEqi5YisehQnjUY2Seap8Oi6Yj5dOSErcAdIEPWAhDSM0LCrjRRZrRkF4bqPQbmzikaxl/Agy/ADS/QHpAKB72AMHoBSl6AgmhgIWgyaBvoEMgAmSGdgYmvlBgN7AkqBE0GLQMdApnldA6BOM0JT/FJObGe4UmPFDX+Am7xQ0E6Tw+kam7Nrw1TVrpZdBobmWak8X4kzqQ4mFmdrcyx6QfHjz84KKIogt/EV1IqHLEqXK5s/inV08pub/Y94ymKZ7dRmoqoYwPIx7JQ9qd6We9Dbqso88nNH0WZ2+yegMeim305ni0sSjy1yfOTe7/nK3crB3vA/Yznfb1VZc2ed9Hy6CbPLvf1nld7tlrR8qyvlaHYokvRze7+nse3S9Hl6Fjb7LlCFJs8l7uHema5ZUdtqOOCetQC0Z4xvomeYdBX4p7iCdRD5yZPofsCT0FIqo94ZpOnF6bgD7HZmGw3txzUmyYVju/XyuoCOZY1lgrLSEtfS64lx5Ju8VhSLSmWOGuMVbNGWe1Wm9VqNVtVK7eSNa7V2Bvwi9/548zynzbEZ2hGquQ1TvLfBuS/AnBm5XQ2BWOVcl4+dggrD26bSuVT9ODRsd5WZhs9MWjyDmHBmHIqHzck2N9f3moxxgT7+cuDllHnVzQxdlMlWoP8ulZG4ypamSGark4R319uJsacV9+YIsquV99YWUlJCYsKkwpjBjsHlJX8ClSH0d9xJZ3EpwbXlI+tCD6SWhnMFYyRWlkevFl8wbmZHWGHS0s2s29FUVmxWRnMjpSOEe3K4JLKyvJWNkHKkc6+hRwi5lspZ8XGLORIt6aF5NaG5LLwPOQyRQG5iAjKknJZERFSTmVCrqk+s7SkKTNTyiTqVC9l6hP1zjLbsyCTlSVlEhpou5TZntAgZIKDpYjbDZE0txRhyeSWIm6WLEUmdIj0DItcf0LkejmSwjpk3CEZx952GcdeyPjP9Kod4vezlkGVU6vEl8PV3tJaUHXwhkV1ScGGKbreNLUy/K2xr3rK1DpR1tQGK721JcGp3hK9aVDVr3RXie5B3pImnBfHVTRVBWpLmgcFBpV6a0oqW4aOyu930ljXnxgrf9SvKBsllOWLsYb2+5XufqJ7qBirnxirnxhraGCoHItkjI+qaLLSkMriqlDZwiNtiNfqlPTKIQna3MEyeAelJ12RsgWnlQ0U6a8M2r1Dgg6Q6Ope1L1IdGFNia4o8QtAuCvpikHpKVvYhnCXhmandwj5FyysX0hJpTNKQn/1uNC0YKEweAj99f/qQl9pMFBTUr8AnxKC2WPLg4WjJ1Y0WSxorRavFBzY3hYZWdpqbAs19kDjQNGoKCcERVuBaIuICAue7v+F4bJYrIIG/kwLC6SxBVRfqQTTysdxpIJx4a9at+AsJbaH+kq8YD3zs/p2HeFp+/0UqpN453ZasDDMhW2xIFyGnsQj9e0mOXEJY/lPWGwBFIrk1YtI3WLaQhbaHXCZud0+ZLxFotkSGQleIms1ftooGAITcArObLI70C0R3T9vFAy6fw44BWfiaarCSf74FdHK61t0lanIx0+bdcZ7KkwB/xRj4tNAq3EgEKlpfDxZo6O50HFko90umX0bHQ7J/IIWs2Da0CIYaLRuuiPJrx0NvdykAu070PH9k77QCrQCKiwsOF7QuxfreP10Z3qf9Ph0J49tS1Ub21JMjscfP/ZPpPAy44CyBxZwUirbGlhq46ojy5HvKHGY+sT1cZ/Hx9nGxI11T+fTTLURU+Oq3ds8u0zvxn7i+jz287hDiV+7Pk/d6zE8CR6PP7kgoSC5PHmuZ5XH0oNnOnokDOR9HOW81FEWN9x9nm2CY7rjc/OXCcfYd1Eai1eiIrVoSnFHWpxki3crkUmtxo94vyHjBfO0cEJSnrDPkael7bOc0e0CYL7bKATAHAl0Ed3RWZq208k0Z8BZ7Wxwqp5AZCQf7wkICzpjhH2deCjgFDZ2mqOigEmyT2iIjIw0j3dGaZpZ1L+R1naGBgsxgWoxmnNBjFUMH2MXtZgoMW5MpkWTUaOJnq2WHZY9FsOieiyF2GcVS5qYhSVJONSSJsaz2MVYFrvQbEkWA1lcafmjkvznat+FfTnP7x9xEMzxTtE7aV6BJtq04/6C/YjdwoOFBYKcA5wxA3r3okls3iSal97H7M3w+frkx/TNy01IdOY5WVxCXm7fPvk+b4ZZ6V/74rJ3F87cdWX1mp4tx/XHFi56YMNli++55u4VP9+3jimNo4t41LEyHvP69r+8/OHrL4r/fCw3Dqhp6mCKR3TcHUj0kDuej1cmmSZFjI+sVWaZ5kTURlrjW4397abaHxgjuFS3wC4xH5iOxR1NVnvHDHT1dhfFjEguco+OqXKNcdfEXJRc415sXhx/lB9N0iiBRTsSE0clVCfMxUdCd/Qqbb3GNU1NcdsstIU/QszYtlG4EattW0C6SmOM3RrrViMTW43DMhwSxeIRXgHz4ybhkMSAo9X4WK4jh/CsmBWYv0sXO4SqiC7Z+UEHcyR7UGvJ8uWL8uk0b34vD/MkYO0FqoSihDzNKobQpNc1GQdapiWQmZ3f7msZFcKzQL2T393S71HS727p8QTpffi9Xye/w8n+EcLn+9GGGDg6T7TJSIC7j09CR+HBmAE9JxUcn1fA4PYBwvNsEqHHz+bNZ4lmeJ+cGuXlkjPOkp4gXM/SfV2k8y/YkvPN5q/aDrG4j99lUeyXA7bmq6euOP4hH23vP+H6pQ+zCYn3bWQepjA769q2u+0nTX9ySx279ZriugdFpoxFODSY3qFE1i2QFhfBol09Xb1cAddc1532uxwPO6zJjq6OoGubS3UJswaSPfmpVodij3bbWDz3x8Wq+CRvWxfH4oxYacPYgJoomURpzERpvsQsFYf91Uys+20tvfvnizLgd3vyVxFzBcTqdQUcWL0UJ3NmV5kzM8R6ppxwtsR6lgk0TlichLNFtID5YmN0tGSOPS3z6X1JrmfZFkqno8xGOCYe7bzg/H7kVORSueoO+g9OEkm1AGm18OAAJwxfvCQQpznNERaz1czNWkRMCjnN0SnYwvzZy5czP9bj/Dynt09en/x+fbEcEy3CDfHxefFeZ/O6dbHJVy46pyqlf+6Ykh07lLUr5s3KLzsv5k+2suopK365ECvv2rYZajpWXgylsTWBBXatu3aWVq6phXpQ5x69m92bmhufmzokda6+SrcOTByYcnbi2SmV1vPtVYlVKTOts+wztIsSZ6Vs09+J+yTpk+R30vbH7U/bqxt6glf1a/74PupArUw9W5uofR75dWqbFumMwsJzmy3MnOCOiqQoV/tqcrWnW5dIhR7hLVfmThvTbAFbta3Bpuoy2eoy2dpg50CkcIstKVw/Jjc0m1h/wiU2oU54wib2vj7CFbYFLDaP54XTayixhpJsFtE2xlax9SzIDjPVwwrZSMSoWJepwutME4MwTYzANDENJjMsJI5Kv0vRBDEcs4uhWIxYfMzlGdoviXVefcix8wtGaGIFfrdfO97RGlqByLaFB50DwtkWsjQv1pkXL1ybkBAfx0Xm7eJUOuXba+8fuLruup0zF+65bOLKHs4HFy1+9KEF9U1tM0zPNY4evcK4/b62n284Z+Dxn5X733jxtXdf2/6+WGeF2I+b4PdeSlMgNrRAkiS6JHZt90WXdsbXzmS1M5ntjLedyWhn0tsZXeyGywSnZsRlDIw4O6Ikc0JGbcbSiJsirsp8MPbRnOcVR0RiclJir/Kc9xJNKXw851ousyVVWasiqmxVkVX2KsdM68yImbaZkTPtMx0bfRu7RHfxZXbJ7NY3c6KtMnKab1rXBd4FmQ2ZN9vusq/uelvOrb3utz1sv6/L/V1bfC/5EuS7CG9ktDPediaznQm/r7n9FcztL2Vuf01sNq3G7kBM2oCJ1i5ZdpuarPvi1cgeqcmt/JFAhitHHgRcha6RrsmuJ107XOZol8c1x7XHpXpcK13c9RxyRTyym9xjAnFCXGMBxjW2k3FiGuNiz2mJS8iXe48W5cxnrEdV6uxUnuqOt6hiGuIhVWQYEXKCCcSKkFPdPSI9ySw50xWITcrPFY/3kTksKYQidl0JInZdunjSpYunXJp4K5fcJUQvfL+Fn08W48gmeSjNzIaip9wDdmazbDGmeB7MgY1CqWTE89ki8wkVYL7bJLRkJ8sZpGPHq87dlssLcxtyea7YRjNJToU0ebzUQ8bnMkjkG8lo8Yi56TIK9cxoudai5dyjdSGMs9ixgE9MITpKjB8tzzjRZnlOy9hDrJBGIq+5eod3vUnzRrSvPbHCkJL8B+efq+H4E8rD88Te17E60YltEGXhwXnYBeVy9WOdygK7If6wKSaGMnOgS/c0rykux+fUYrRYTTFnOPQUiuhqSWGm7oC0OFTTo7wplOF12K3dbCmsa5cIm9mvppBHS01h+NAhDtIhkMfobP/y5cupU7Jgk+Yjx59oEEKx/RJCy7+Lr0sP3ie/b79QekDul8k/LjEBdxqPjxNbta+wOfr6y5Yu7pN188t3jCzqn/3HsZc/N9EZtNfPWDozIaFnylVbb5sw4+XLd3zAznLPml9bcpY3KSt3+PJzhy7p6vEPu2x60piqMf287tRYW2Ze0dKqievOe0xkkEzjCM823YGd2rOZ7PjMIDwQ2RpmrO2MpZ0xtzM2EeZeX36EiJKxYBpcjJjdYWMKJWgR/mgbdgYlMlrLoAzmOClZ20LJ2s4Mi7U0orTaMtfSYFllUcmiW9ZbgpZtlp0Ws0XsAGLbtoR2AMkc2SjSuCV02g4z8tgk9g0Re2AOiw0FnFmenkSAywPUFj6Tkljfpgs7PghJzyB9HywQCbxA2/9dgTwrHy8QqduZl6e9Ks5MYdGsxNB5WWzTzn5OsTXHCQ9yLfmcgimzc666quWpp2L9XdPuWacNrr2XT13BLLPbblxx/OYROaHfqxRSmLhMioI0wSjJ9I/IbfSj1SArWY02iqAI4zjZyCb/rz0SaIdLjpODHMAoidEUBdQoGugE/oI93wmMpRhgHMUC44E/UwLFARMpHpgEPEYuSgSfTC7wKZQMdEtMpRRgGrmNn8gjUadUYDp5gBmkA73AHymT0oFZlAH0AX+gLuQFdkUc/UDdyAfMluinLsZRyqGuwO4Se1A2sCf5gb2oO7A38HvKpR7APOoJzKdexnfUR2Jf6g3sR3nA/pRv/JMGSBxIfYCDJBZQX+BZ1A84mPoDC2mAcYQCNBBYRIOAQ6gAWAz8lkroLGApDQaWYfc8TEMpABxGRcDhNAR4tsRyKgaeQyXAEfjce4jOlTiShgJH0TDgaBpufENjJI6ls4Hj8BnoII2nEcAJEs+jc4EVNNL4B1XSKOBE4EE6n0aDr6KxwEk0DniBxMk03viaqmkCsIbOA04B/p2mUiVwGk0E1tL5wAupyviKpkuso0nAGXSBcYBmUjX4WRJnUw3wIpqC9otpKnCOxLk0zfiS5lEtcD5NB9ZLXEB1xhe0kGYAF9FM4CXAz2kxzQIuoYuAl9LFwMskLqU5wMtpLvAKmmfsp2USG6geuJwWAP9ACw3x/9qLgFdJvJouMfbRNbQYeC0tAV5HlwKvp8uMT6mRlgJvoMvRsgL4Kd1IVwBvomXAlbQcuAq4l/5IfwCupiuBN9NVxh66ReKtdDVwDV0LvI2uQ+/twD10B10PXEuNxm66k24A3kUrgH+SeDfdBFxHK4HraRXwHuAndC/9EXgfrQbeTzcDH6BbjI/pQbrV+IgeojXADXQb8GGJj9DtwEfpDuBjdCfwcYlP0F3AJ+lPwCDdDWwCfkjNtA7YQuuBG+le4wN6iu4z/kabJD5N9wNb6QHgZnoQuEXiM7QB+Cw9bLxPz9EjwD9L3EqPArfRY8C/0OPA5+kJ4Av0pPEevUhB4EvUZLxLL0v8KzUDX6EWYxe9ShuB2+kp4Gu0Cfg6PQ18A5+CdtGbtBm4Q+JO2gJ8i54Fvk3PGe/QO8C3aRf9GfgubQW+R9uMt+h9iX+j54Ef0AvAD+lF4EcSP6aXgJ/Qy8Dd9FdjJ+2RuJdeNXbQp7QduI9eA34mcT+9Dvyc3gB+QW8Cv6Sdxpt0QOJX9Bbw7/S28QZ9Te8A/yHxIO0CfkPvGa/TIXofeFjit/Q34BH6APhP+hD4ncTv6WPjNTpKnwB/oN3AH4Hb6SfaAzxGe4E/06fAXyQep8+MV6mN9gMN+hz4n5z+P5/Tv/2d5/Svzzinf/UvcvpXp+X0A/8ip395Wk7/4gxy+v4TOX3+STn9s3+R0z+TOf2z03L6PpnT93XK6ftkTt8nc/q+Tjn909Ny+l6Z0/fKnL73d5jTP/j/lNN3/Sen/yen/+5y+u/9nP77zen/6pz+n5z+n5z+6zn9ld9/Tv8/7yjp0QplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9BQUFBQUErQXJpYWxNVAovRmxhZ3MgNAovQXNjZW50IDkwNS4yNzM0NAovRGVzY2VudCAtMjExLjkxNDA2Ci9TdGVtViA0NS44OTg0MzgKL0NhcEhlaWdodCA3MTUuODIwMzEKL0l0YWxpY0FuZ2xlIDAKL0ZvbnRCQm94IFstNjY0LjU1MDc4IC0zMjQuNzA3MDMgMjAwMCAxMDA1Ljg1OTM4XQovRm9udEZpbGUyIDggMCBSPj4KZW5kb2JqCjEwIDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0ZvbnREZXNjcmlwdG9yIDkgMCBSCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL1N1YnR5cGUgL0NJREZvbnRUeXBlMgovQ0lEVG9HSURNYXAgL0lkZW50aXR5Ci9DSURTeXN0ZW1JbmZvIDw8L1JlZ2lzdHJ5IChBZG9iZSkKL09yZGVyaW5nIChJZGVudGl0eSkKL1N1cHBsZW1lbnQgMD4+Ci9XIFswIFs3NTAgMCAwIDI3Ny44MzIwM10gNTUgWzYxMC44Mzk4NF0gNzEgNzIgNTU2LjE1MjM0IDczIFsyNzcuODMyMDNdIDgzIFs1NTYuMTUyMzQgMCAwIDUwMCAyNzcuODMyMDNdXQovRFcgMD4+CmVuZG9iagoxMSAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMjYyPj4gc3RyZWFtCnicXZHNasQgFIX3PsVdTheDTpKZoRACZUohi/7QtA9g9CYVGhVjFnn7+pOmUEHlcO539Cq9tY+tVh7omzOiQw+D0tLhbBYnEHoclSanAqQSflNpFRO3hAa4W2ePU6sHQ+oagL4Hd/ZuhcODND3eEfrqJDqlRzh83rqgu8Xab5xQe2CkaUDiEJKeuX3hEwJN2LGVwVd+PQbmr+JjtQhF0qd8G2EkzpYLdFyPSGoWRgP1UxgNQS3/+WWm+kF8cZeqy1DNWMGaqMprUucqqXP2riwlbUzxm7AfWGWouk/bZWMvOSl713KLyFC8V3y/vWmxOBf6TY+cGo0tKo37P1hjIxXnDxIJhhgKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUwCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL0VuY29kaW5nIC9JZGVudGl0eS1ICi9EZXNjZW5kYW50Rm9udHMgWzEwIDAgUl0KL1RvVW5pY29kZSAxMSAwIFI+PgplbmRvYmoKeHJlZgowIDEyCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxNSAwMDAwMCBuIAowMDAwMDAwMzk3IDAwMDAwIG4gCjAwMDAwMDAxMDggMDAwMDAgbiAKMDAwMDAxMDgxMSAwMDAwMCBuIAowMDAwMDAwMTQ1IDAwMDAwIG4gCjAwMDAwMDA2MDUgMDAwMDAgbiAKMDAwMDAwMDY2MCAwMDAwMCBuIAowMDAwMDAwNzA3IDAwMDAwIG4gCjAwMDAwMDk5MzQgMDAwMDAgbiAKMDAwMDAxMDE2OCAwMDAwMCBuIAowMDAwMDEwNDc4IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxMgovUm9vdCA3IDAgUgovSW5mbyAxIDAgUj4+CnN0YXJ0eHJlZgoxMDk1MAolJUVPRg==",
                                "contentType": "application/pdf"
                            }
                        ],
                        "effectiveDateTime": "2024-02-25T15:10:56.296677",
                        "code": {
                            "coding": []
                        }
                    }
                },
                {
                    "name": "labTestCollection",
                    "part": [
                        {
                            "name": "labTest",
                            "resource": {
                                "resourceType": "Observation",
                                "code": {
                                    "text": "Hepatic Function Panel (7)",
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "24325-3",
                                            "display": "Hepatic Function Panel (7)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "status": "final"
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "2885-2",
                                            "display": "Protein, Total"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "value": 9.6,
                                    "unit": "g/dL",
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 6.0
                                        },
                                        "high": {
                                            "value": 8.5
                                        },
                                        "text": "6.0-8.5"
                                    }
                                ],
                                "interpretation": [
                                    {
                                        "text": "Abnormal",
                                        "coding": [
                                            {
                                                "code": "A",
                                                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                                                "display": "Abnormal"
                                            }
                                        ]
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "coding": [
                                        {
                                            "code": "1751-7",
                                            "system": "http://loinc.org",
                                            "display": "Albumin"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "g/dL",
                                    "value": 3.8,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 3.6
                                        },
                                        "high": {
                                            "value": 4.6
                                        },
                                        "text": "3.6-4.6"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "Bilirubin, Total",
                                    "coding": [
                                        {
                                            "code": "1975-2",
                                            "system": "http://loinc.org",
                                            "display": "Bilirubin, Total"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "mg/dL",
                                    "value": 0.3,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 0.0
                                        },
                                        "high": {
                                            "value": 1.2
                                        },
                                        "text": "0.0-1.2"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "Alkaline Phosphatase",
                                    "coding": [
                                        {
                                            "code": "6768-6",
                                            "system": "http://loinc.org",
                                            "display": "Alkaline Phosphatase"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "IU/L",
                                    "value": 83.6,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 44.0
                                        },
                                        "high": {
                                            "value": 121.0
                                        },
                                        "text": "44-121"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "AST (SGOT)",
                                    "coding": [
                                        {
                                            "code": "1920-8",
                                            "system": "http://loinc.org",
                                            "display": "AST (SGOT)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "IU/L",
                                    "value": 19.4,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 0.0
                                        },
                                        "high": {
                                            "value": 40.0
                                        },
                                        "text": "0-40"
                                    }
                                ]
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "text": "ALT (SGPT)",
                                    "coding": [
                                        {
                                            "code": "1742-6",
                                            "system": "http://loinc.org",
                                            "display": "ALT (SGPT)"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-01-11T17:37:30.756832+00:00",
                                "valueQuantity": {
                                    "unit": "IU/L",
                                    "value": 13.5,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 0.0
                                        },
                                        "high": {
                                            "value": 44.0
                                        },
                                        "text": "0-44"
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "name": "labTestCollection",
                    "part": [
                        {
                            "name": "labTest",
                            "resource": {
                                "resourceType": "Observation",
                                "code": {
                                    "text": "Vitamin D, 25-Hydroxy",
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "62292-8",
                                            "display": "Vitamin D, 25-Hydroxy"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-02-25T15:10:56.296677",
                                "status": "final"
                            }
                        },
                        {
                            "name": "labValue",
                            "resource": {
                                "resourceType": "Observation",
                                "status": "final",
                                "code": {
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "62292-8",
                                            "display": "Vitamin D, 25-Hydroxy"
                                        }
                                    ]
                                },
                                "effectiveDateTime": "2024-02-25T15:10:56.296677",
                                "valueQuantity": {
                                    "unit": "ng/mL",
                                    "value": 41.0,
                                    "system": "http://unitsofmeasure.org"
                                },
                                "referenceRange": [
                                    {
                                        "low": {
                                            "value": 30.0
                                        },
                                        "high": {
                                            "value": 100.0
                                        },
                                        "text": "30.0-100.0"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        }
        ```
  - **Only report data (no tests or values)**
        ```json
        {
            "resourceType": "Parameters",
            "parameter": [
                {
                    "name": "labReport",
                    "resource": {
                        "resourceType": "DiagnosticReport",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                                        "code": "LAB",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/4cc6fd69f81042a0b6d123e2080a7c1a",
                            "type": "Patient"
                        },
                        "presentedForm": [
                            {
                                "data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoVW50aXRsZWQgZG9jdW1lbnQpCi9Qcm9kdWNlciAoU2tpYS9QREYgbTEwNCBHb29nbGUgRG9jcyBSZW5kZXJlcik+PgplbmRvYmoKMyAwIG9iago8PC9jYSAxCi9CTSAvTm9ybWFsPj4KZW5kb2JqCjUgMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDE4Mj4+IHN0cmVhbQp4nHWQ0QrCMAxF3/MV+QG7pmmaFsQHQfes9A/UDYQ9OP8fbDfdQFhTmnIP9zaU0JbaUTk0ObwN8AKjMqm/XkTCWtcW58vYQ9My9m+oPFJAshJwfEAHl78EdXWXjK/jmKE5eyRvQl2KuQNapzBeUyTlhHmAqrFxquw5Yr7j3lrWA+YnqGEXUhAunhn4OIFoSIisxgVIWByRnKz6nOSNVUoqugDLG0B44wmvWyBN4JTLv3wAWrRKswplbmRzdHJlYW0KZW5kb2JqCjIgMCBvYmoKPDwvVHlwZSAvUGFnZQovUmVzb3VyY2VzIDw8L1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldCi9FeHRHU3RhdGUgPDwvRzMgMyAwIFI+PgovRm9udCA8PC9GNCA0IDAgUj4+Pj4KL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KL0NvbnRlbnRzIDUgMCBSCi9TdHJ1Y3RQYXJlbnRzIDAKL1BhcmVudCA2IDAgUj4+CmVuZG9iago2IDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9Db3VudCAxCi9LaWRzIFsyIDAgUl0+PgplbmRvYmoKNyAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyA2IDAgUj4+CmVuZG9iago4IDAgb2JqCjw8L0xlbmd0aDEgMTg0MjgKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA5MTQxPj4gc3RyZWFtCnic7XoJeFRF1vapureXdLqT29k76aRv0kkD6bAlYY+kQxbAiOyYYJAEiIRFWQIIihLGPaIwqKjoCO64dxLEgDowbqO4gIo6boCIiuMgyCgqSu7/VnWHBHC+n/H/vu9/fJ65N+etU1Xnnqp7zqlT1d0hRkSxAJV6DS0pLWOFLI+I7UVr/tBRI8deMWV9IpFiRf2uoWPHD7H92bIC/UHUe40c2zN3ccLTLiK+AfXqCSUjKkatnvk9Ud86IuctUy+qmctXsLvRfw76q6YuWqDf437/ayLzL6BxF86dftHrSyrXEjlGoX7x9Jr6uZREEdBfAHlt+uwlF046+GkrUdeuRFGD66ZdtPiF63+4ARPeRmTdUFdbM21v3MvQx+NIDIqGmLyIdDyPOVJm3UULFmd8yf9MZLoLbdWz50ytydqe/hbe5370N19Us3iuqcXRgD4xP/3imotqE6t7fwJjVKCtZO6c+gVGNq0BP1v0z51fOzfrvRFbidx4v0joJYWsxMlJzDDAC1tW0BEqoD+RBe0a9aQJ0PYYZE2oKyQvo4vQ+SsXnrcMbjuXijU69uSxSzXZctJVIVts1AO3qWZ+zRTSpy6ZP5v06fNrZ5FeVztlPumzaxZcTHqHTrKHeU7mcJsiZ9sPN6OhNBw4FjfDbM8DimdMrrWPttz61uTogu+tKVb52L2fdckW5WujBm069uTx6RpZheaITrPk0iZEcWFrxCGuhqGMknYyY1bj6EKaSwtoPSxGsj4N9XpRNz47cU897c0V5Tq2Cla0mtaaRISmhErlLbqQx1hNPNKscnGp4RmcuEaMPHckBTDSetM7baNZnmUwaw4Ih2F81Wd6Rs5CDdt1CFWRIi2aE7KotKV4C+E3A1K8E8868Rh1Vu18yHbGsP2FHIcFmCSNQnPsgXGTw77oJ30w3PhI1IDDjFSaAIKPUPvfvpb/1zdbxW9VRpx+q8PFbZ5p8UgtFpoookDFeqaZ1BDmGay8KMxzxEVdmFfgo65hXu0kY4KNosK8GRxREc2nGVRDs2kEomcC1aJej5Y5JKK+D+zam3qhf4RsmYNYW4IIq0XfcLoI7dMhezFQp+6gDm06jYHUdFoIvgatJ9c65B6GZC5G6I1bxG+d1H36aMWozQcvsAbtoRn2kGPODo83AyPUoa8+PHq9fJtFwGnUw9x5YQ34X4+C/9FL/QwW/H95vp7KQOWwS+wZyl97gicqxHOZpi3kAiWbHiKX6sPOQ8aXoAOibJthHBD9ouR/x0OtYSLaQI+zGfQ4baXn2WE89SRtpo30CiVSCd1FS+kWjGRG7L9C18OnYxDBJXQLcxkbsRvcg0i+h96A7Hl0BW2hBJZkfEXL6GrlHTx1NTkoA9ExCpFyIzvHWIhstEe9EtnhHETOXNZgVBg3GauN++kB2qy8YhynSKyOqbjfML4x/c34GBFdRbfSHbSHrY54CivqPKy7zcqfEFNrlUkqM6YbxzCDdLoEc1ARs2+wbdwP7bX0JUtiS5ViaLnPCBovQspNkxCba2kL68OG8nRTlTHCeIMSMMZiaL2DmmkT7lZ6jj5kdtNh437jMLkoB6tsGezxJtumtB1f3lYIi5lgpW40AD1z6M/0V9rJvOwvfI7Jbso1BUyXGruQKXvTeMz2ITz5BfuBX4F7mfKyWmYMwZq/mv4orE0v0acsmfVkI9kE3o3P4Xcr85FRc+RKnIa1dD3dDu27mZ9t4na+Q7lPfVT92ZzatteIgkd8dCf25b8wB95UZ/XsD+w99hkv5pP5nXyfcov6sPq2pQZvfQGyxI30KP3AYlh/Npqdz+rYUnYt+yO7g73BdrIDvIiP47P4IaVOmac8pw7BPVatV680XWO6wXygraLtxba32n4wco1raDTiYTlmfyvdjTfbTDvoA9x7aB8zsUgWhVtn6Ww8uwz3FexGdi/bwB5mGzHKTraPfcWOsO/ZzxyJkpt5Ck/nGbi9fD6/hN/C7+I7cO/k/+A/KYlKhuJX+igFSqUyB7O6VlmF+ynlUzVZ3aEasHOuaY1pnWmD6VHT86bDZrvlD1ayvv7Lfcezj+9uo7br2ta0NbdtND6lePgwGVbw4BQzGnmrBrl7Mc4rDyDO32F22C6ZZbPB7BxYZjKbyeaxxbDkVWwte0DO/Qn2LKz0PjuEOTu4W865B+/Dh/CRuC/gtXweX8VX8438PX5MsSiRSrQSr2QrQ5VJSq2yQFmirFGCyuvKJ8o+5ajyC25DtakeNUP1qX51qDpZXajerX6pfmmqMr1m+txsM19kvsbcav7W0tcy2DLKMtoyybLSssmyy1qN6HyBnqKnO+cBtldZrpQqT9FNPE918Tf5m4jnyTRNGcELxTmWXccvZxt5pmmxeRAfxM6lw6oPtn6Zr+NH+SBlBCtnY2km7x3SZo5TH0FRoL5AB9Vn8W5vQvNis51dwQ+Z7dTMZN5mLym9VL/yGn2o7GEW9R76SLWxRHaQP6SMQhQ8pw42VVC6chc9ocxjl9NTvBRHkZ+tKxDH57JHkBfGsVz2o4ITJj8XUdRP+YyupFn8b3QQ6/g6uo1NU6fTTZTHltKX9CBWRTfTxeZsczx7lc9QG3ks20hcfVjsISyTKaY4uopNUtaaD/EPsLvtUG20W3kMs9/Bn8Aeftg0htVhBVxO19A8YzktMVWob7PppLAJlKXuRXZbquSq6SiXIatUIadtwuregjxQpIxASxIi5xzExXhkiLW4b0eeUBFBM7DGz0MWe5M2msfxVppuimLIOsjGr7WNoYnGg3SHMZ0uNlZTd+SDa42l0LiBPqeVtIFd3XYZ9tE0rJzd7BxTGd9hKjO680b+AR/L15zsX1g7iyXR33E/gcpgnO8a1fdxti00VhjvIrq7IsPeQVPobNqPt/wGIwxTtlFe27m8yShT5uJ999Bo4yHDw2xUZ8ymkfQsPWAxUY3FDx8H2dt438uolo8xFii1bTNgh5WwQgDWWoj8c32gePy4okDh4LMKBg0c0L9fn/y83N69evbonuPP7ta1iy8r05uRrnvSUt0pya6kxIT4uNgYpxYd5bBH2iKsFrNJVTijnFJvWbUe9FUHVZ932LDuou6tQUNNp4bqoI6mspNlgnq1FNNPlgxA8sJTJAMhycAJSabpBVTQPUcv9erBN0q8eiubOLoC/I0l3ko9eFDyIyS/SvIO8OnpeEAvTaor0YOsWi8Nli2qayytLoG6pkhbsbe41tY9h5pskWAjwQUTvXObWOJgJhmeWDqwCSdjByYVTPaWlAZd3hIxg6CSVVozLThqdEVpSUp6emX3nCArnuqdEiTvkGC0X4pQsRwmaC4OWuQw+gzxNnSD3pSzrXFFq0ZTqv32ad5pNVUVQaWmUozh9GPckmDipfuTOqpQHlNccW3n3hSlsTRphi6qjY3X6sH1oys696YLrKyEDjzLs8qqG8sw9AoYsXysjtH41ZUVQXY1htTFm4i3Cr1frbdUtFTP1IMR3iHeusaZ1XBNcmOQxixJb05ODmw29lJyqd44rsKbHixM8VbWlLib4qhxzJIWV0B3ndzTPadJc4YM2xQVHWbsjs5M7Yk+yUlxwZWPOWFZJmbkHY6ACOpTdcykwot36i+gtj81Tu0PMVyVDE8Fp8EjM4IRxdWN2kDRLp4PmrI0r974PSECvAf/cXJLTbjFnKV9T4IVcXIi1NDfzgf9/mB2tggRSzF8ijkOlvU+3XMWtXKvd66mo4D5aBRsW1M5sCfMn54uHHxDa4CmoBJsGF0Rqus0JaWZAj39lUFeLXq2tffEjxc9De09Jx6v9iKSN8oTd3zQ6jvxF60lxJbWDQyyhP+iuzbUXz7WWz56YoVe2lgdtm35uJNqof7+J/rCXDC2uEJJ4WGOpyiyF0FZdUJYVCrsQTULf2YZ1NNaLVZEpWxhellQqx4WwkpbevoZPtRqHBZPyaLjsfA0gwP9J9cHnVQ/aXr2RgUTxlZZPm5iY6PtpD6EWmjA4eECEU/jKtL14iCNx8rMwl+rsa2/oMqUYAAmKxYCiL9QU7h6kmBKmK/EJaKze04ZEl1jY5lXL2usbqxpNRqmeHXN27iZP8+fb5xbWt0eOK3GlhtSgmUrKmGrOjYQi4LTkCYvu250U4BdN3ZixWaNSL9uXEUzZ7y4ekhlUyb6KjbrRAHZykWraBQVXVSonOElm7lVyqdsDhA1yF5VNsj61FZGss3a3sZoaisPtWntbRxtaqgtINvEJXJM8biKztEjl2Rld7nh4XMLVUVarad873GGl/nUulnt3GeGTntExG/TbTm1blE694maw2YjUunfv/5vuqEzOjLyt+mOOKVutXZogZlFTbPb/3t0R0SonfuEbqfDIT4z/XfoNnXuE7pjo6J+m277KfXIyI7IgZlt0BmvaafH02/SbT9JtxgpKSbmdJ+fyRV1at1h6dxnRy0lLk769d++tFPq0dEduqOhHjpTExJ+m+5Tv9XQtA4tGDcaNT0p6XSf/xbdTqetg4d66Ex3uX6b7vhT6jGddMOFTujMcrvFd63//pV46lhxHVowbgxq2bp+ejydyZV86liJjs7jxkFnD68XCes36HafOlZyR1RiXDFSrs93eqyeyeU5dSx3hxaM60Ktb7duMh7/7Sv9lHpaWoeWNKwb1Abm5Jy+Ds7kyjylrusdWnSsG9SKc3NPj9UzubqdUs/K6tCSRZSBWnn//qfH6plc3U+pZ2d3aMkm8qE2dvDg02P1TK78U+o9eiR18FAPnVWlpafH6plcp35/nJeX0sFDPXROKy8/PVbP5Bp8Sr1//9QOHrENnZtpnNK1xZfk2fms0o32grjSrdmf6tmsdFFSmwd5Aq2KtyUmPje6qLui42zUU6IOnAN6ErRVEb/TTFbSxG8owGWgBtCToK2gnSDsFEDRq4PmgNaB9ooeJVVxN+seraiL4sKzLpy1opVEOgQyQAp5gD1BI0GTQStB60BmKSda5oCWgbaCDsuegJLYvDoPc09svkEWLTNn58pqTahaNUlWW86rDJUjRofKkuEhsYEhsd75oeYeQ0Jll5xQGZOV2yBKmyN3W1GCkoCXTMDE5wIZf5GiGUMCWK/EUxDEFXO4JaDEtGT6ctdtVVRiClcYTSOPsU1hzQ5nbpGNG/wQkrGHf8MPhnr4wZYoZ+66orP5PnoStBWk8H24P+Wf0jK+V9gcWAhaB9oK2gE6BDLzvbj34N7Nd1M0/4R6ggpBk0HrQFtBh0AW/glQ4x+Lz1ESBV8I4vxjoMY/wmt9BIzmH4L7kH+Iqb3T3G9A7mbJ+HuGGU9WmElMCTMxCbmt/O3mn7ohonzwNCLqGSUDoZmnZDRn9fa0KknNBTM8rfyzFt3vWV/Ui++iIIhjJrsw8i7SQaNA1aC5IDO498C9Rw2gVaD1oCAIUQbUQDrfDnod9B71AgVAo0BWvrMZw7TyHc2+IZ6iBP4m/ytSgoe/wV+R5ev8ZVm+xl+S5aso01Bu5y83p3moKBL9hGc0lBrKnug38b+0ZMZ4jCIn3wrbeYA9QYWgkaDJoJUgM9/KM5qneWKg5BnajoOChzfTV7J8kO61UmCmJ+ArRgDqAnwDzwIHWKev8/GAb80dqArw3bQanADfVSvACfBduhycAN/sReAE+KbNBCfAN3EyOAG+kePAAVr53U9ndvH0GzmL6UXR/BJY6RJY6RJY6RJS+SXipp9UMbc7m7OzYbG1AX+3bE/DFtbwLGsYwxruZQ21rOEK1rCcNRSwhgtYg581uFlDGmsIsIZnWH+YooEFNp5UHRBIYg3bWcPjrKGeNfhYQxZryGQNOusXaOXpzcPzZFEqi5YisehQnjUY2Seap8Oi6Yj5dOSErcAdIEPWAhDSM0LCrjRRZrRkF4bqPQbmzikaxl/Agy/ADS/QHpAKB72AMHoBSl6AgmhgIWgyaBvoEMgAmSGdgYmvlBgN7AkqBE0GLQMdApnldA6BOM0JT/FJObGe4UmPFDX+Am7xQ0E6Tw+kam7Nrw1TVrpZdBobmWak8X4kzqQ4mFmdrcyx6QfHjz84KKIogt/EV1IqHLEqXK5s/inV08pub/Y94ymKZ7dRmoqoYwPIx7JQ9qd6We9Dbqso88nNH0WZ2+yegMeim305ni0sSjy1yfOTe7/nK3crB3vA/Yznfb1VZc2ed9Hy6CbPLvf1nld7tlrR8qyvlaHYokvRze7+nse3S9Hl6Fjb7LlCFJs8l7uHema5ZUdtqOOCetQC0Z4xvomeYdBX4p7iCdRD5yZPofsCT0FIqo94ZpOnF6bgD7HZmGw3txzUmyYVju/XyuoCOZY1lgrLSEtfS64lx5Ju8VhSLSmWOGuMVbNGWe1Wm9VqNVtVK7eSNa7V2Bvwi9/548zynzbEZ2hGquQ1TvLfBuS/AnBm5XQ2BWOVcl4+dggrD26bSuVT9ODRsd5WZhs9MWjyDmHBmHIqHzck2N9f3moxxgT7+cuDllHnVzQxdlMlWoP8ulZG4ypamSGark4R319uJsacV9+YIsquV99YWUlJCYsKkwpjBjsHlJX8ClSH0d9xJZ3EpwbXlI+tCD6SWhnMFYyRWlkevFl8wbmZHWGHS0s2s29FUVmxWRnMjpSOEe3K4JLKyvJWNkHKkc6+hRwi5lspZ8XGLORIt6aF5NaG5LLwPOQyRQG5iAjKknJZERFSTmVCrqk+s7SkKTNTyiTqVC9l6hP1zjLbsyCTlSVlEhpou5TZntAgZIKDpYjbDZE0txRhyeSWIm6WLEUmdIj0DItcf0LkejmSwjpk3CEZx952GcdeyPjP9Kod4vezlkGVU6vEl8PV3tJaUHXwhkV1ScGGKbreNLUy/K2xr3rK1DpR1tQGK721JcGp3hK9aVDVr3RXie5B3pImnBfHVTRVBWpLmgcFBpV6a0oqW4aOyu930ljXnxgrf9SvKBsllOWLsYb2+5XufqJ7qBirnxirnxhraGCoHItkjI+qaLLSkMriqlDZwiNtiNfqlPTKIQna3MEyeAelJ12RsgWnlQ0U6a8M2r1Dgg6Q6Ope1L1IdGFNia4o8QtAuCvpikHpKVvYhnCXhmandwj5FyysX0hJpTNKQn/1uNC0YKEweAj99f/qQl9pMFBTUr8AnxKC2WPLg4WjJ1Y0WSxorRavFBzY3hYZWdpqbAs19kDjQNGoKCcERVuBaIuICAue7v+F4bJYrIIG/kwLC6SxBVRfqQTTysdxpIJx4a9at+AsJbaH+kq8YD3zs/p2HeFp+/0UqpN453ZasDDMhW2xIFyGnsQj9e0mOXEJY/lPWGwBFIrk1YtI3WLaQhbaHXCZud0+ZLxFotkSGQleIms1ftooGAITcArObLI70C0R3T9vFAy6fw44BWfiaarCSf74FdHK61t0lanIx0+bdcZ7KkwB/xRj4tNAq3EgEKlpfDxZo6O50HFko90umX0bHQ7J/IIWs2Da0CIYaLRuuiPJrx0NvdykAu070PH9k77QCrQCKiwsOF7QuxfreP10Z3qf9Ph0J49tS1Ub21JMjscfP/ZPpPAy44CyBxZwUirbGlhq46ojy5HvKHGY+sT1cZ/Hx9nGxI11T+fTTLURU+Oq3ds8u0zvxn7i+jz287hDiV+7Pk/d6zE8CR6PP7kgoSC5PHmuZ5XH0oNnOnokDOR9HOW81FEWN9x9nm2CY7rjc/OXCcfYd1Eai1eiIrVoSnFHWpxki3crkUmtxo94vyHjBfO0cEJSnrDPkael7bOc0e0CYL7bKATAHAl0Ed3RWZq208k0Z8BZ7Wxwqp5AZCQf7wkICzpjhH2deCjgFDZ2mqOigEmyT2iIjIw0j3dGaZpZ1L+R1naGBgsxgWoxmnNBjFUMH2MXtZgoMW5MpkWTUaOJnq2WHZY9FsOieiyF2GcVS5qYhSVJONSSJsaz2MVYFrvQbEkWA1lcafmjkvznat+FfTnP7x9xEMzxTtE7aV6BJtq04/6C/YjdwoOFBYKcA5wxA3r3okls3iSal97H7M3w+frkx/TNy01IdOY5WVxCXm7fPvk+b4ZZ6V/74rJ3F87cdWX1mp4tx/XHFi56YMNli++55u4VP9+3jimNo4t41LEyHvP69r+8/OHrL4r/fCw3Dqhp6mCKR3TcHUj0kDuej1cmmSZFjI+sVWaZ5kTURlrjW4397abaHxgjuFS3wC4xH5iOxR1NVnvHDHT1dhfFjEguco+OqXKNcdfEXJRc415sXhx/lB9N0iiBRTsSE0clVCfMxUdCd/Qqbb3GNU1NcdsstIU/QszYtlG4EattW0C6SmOM3RrrViMTW43DMhwSxeIRXgHz4ybhkMSAo9X4WK4jh/CsmBWYv0sXO4SqiC7Z+UEHcyR7UGvJ8uWL8uk0b34vD/MkYO0FqoSihDzNKobQpNc1GQdapiWQmZ3f7msZFcKzQL2T393S71HS727p8QTpffi9Xye/w8n+EcLn+9GGGDg6T7TJSIC7j09CR+HBmAE9JxUcn1fA4PYBwvNsEqHHz+bNZ4lmeJ+cGuXlkjPOkp4gXM/SfV2k8y/YkvPN5q/aDrG4j99lUeyXA7bmq6euOP4hH23vP+H6pQ+zCYn3bWQepjA769q2u+0nTX9ySx279ZriugdFpoxFODSY3qFE1i2QFhfBol09Xb1cAddc1532uxwPO6zJjq6OoGubS3UJswaSPfmpVodij3bbWDz3x8Wq+CRvWxfH4oxYacPYgJoomURpzERpvsQsFYf91Uys+20tvfvnizLgd3vyVxFzBcTqdQUcWL0UJ3NmV5kzM8R6ppxwtsR6lgk0TlichLNFtID5YmN0tGSOPS3z6X1JrmfZFkqno8xGOCYe7bzg/H7kVORSueoO+g9OEkm1AGm18OAAJwxfvCQQpznNERaz1czNWkRMCjnN0SnYwvzZy5czP9bj/Dynt09en/x+fbEcEy3CDfHxefFeZ/O6dbHJVy46pyqlf+6Ykh07lLUr5s3KLzsv5k+2suopK365ECvv2rYZajpWXgylsTWBBXatu3aWVq6phXpQ5x69m92bmhufmzokda6+SrcOTByYcnbi2SmV1vPtVYlVKTOts+wztIsSZ6Vs09+J+yTpk+R30vbH7U/bqxt6glf1a/74PupArUw9W5uofR75dWqbFumMwsJzmy3MnOCOiqQoV/tqcrWnW5dIhR7hLVfmThvTbAFbta3Bpuoy2eoy2dpg50CkcIstKVw/Jjc0m1h/wiU2oU54wib2vj7CFbYFLDaP54XTayixhpJsFtE2xlax9SzIDjPVwwrZSMSoWJepwutME4MwTYzANDENJjMsJI5Kv0vRBDEcs4uhWIxYfMzlGdoviXVefcix8wtGaGIFfrdfO97RGlqByLaFB50DwtkWsjQv1pkXL1ybkBAfx0Xm7eJUOuXba+8fuLruup0zF+65bOLKHs4HFy1+9KEF9U1tM0zPNY4evcK4/b62n284Z+Dxn5X733jxtXdf2/6+WGeF2I+b4PdeSlMgNrRAkiS6JHZt90WXdsbXzmS1M5ntjLedyWhn0tsZXeyGywSnZsRlDIw4O6Ikc0JGbcbSiJsirsp8MPbRnOcVR0RiclJir/Kc9xJNKXw851ousyVVWasiqmxVkVX2KsdM68yImbaZkTPtMx0bfRu7RHfxZXbJ7NY3c6KtMnKab1rXBd4FmQ2ZN9vusq/uelvOrb3utz1sv6/L/V1bfC/5EuS7CG9ktDPediaznQm/r7n9FcztL2Vuf01sNq3G7kBM2oCJ1i5ZdpuarPvi1cgeqcmt/JFAhitHHgRcha6RrsmuJ107XOZol8c1x7XHpXpcK13c9RxyRTyym9xjAnFCXGMBxjW2k3FiGuNiz2mJS8iXe48W5cxnrEdV6uxUnuqOt6hiGuIhVWQYEXKCCcSKkFPdPSI9ySw50xWITcrPFY/3kTksKYQidl0JInZdunjSpYunXJp4K5fcJUQvfL+Fn08W48gmeSjNzIaip9wDdmazbDGmeB7MgY1CqWTE89ki8wkVYL7bJLRkJ8sZpGPHq87dlssLcxtyea7YRjNJToU0ebzUQ8bnMkjkG8lo8Yi56TIK9cxoudai5dyjdSGMs9ixgE9MITpKjB8tzzjRZnlOy9hDrJBGIq+5eod3vUnzRrSvPbHCkJL8B+efq+H4E8rD88Te17E60YltEGXhwXnYBeVy9WOdygK7If6wKSaGMnOgS/c0rykux+fUYrRYTTFnOPQUiuhqSWGm7oC0OFTTo7wplOF12K3dbCmsa5cIm9mvppBHS01h+NAhDtIhkMfobP/y5cupU7Jgk+Yjx59oEEKx/RJCy7+Lr0sP3ie/b79QekDul8k/LjEBdxqPjxNbta+wOfr6y5Yu7pN188t3jCzqn/3HsZc/N9EZtNfPWDozIaFnylVbb5sw4+XLd3zAznLPml9bcpY3KSt3+PJzhy7p6vEPu2x60piqMf287tRYW2Ze0dKqievOe0xkkEzjCM823YGd2rOZ7PjMIDwQ2RpmrO2MpZ0xtzM2EeZeX36EiJKxYBpcjJjdYWMKJWgR/mgbdgYlMlrLoAzmOClZ20LJ2s4Mi7U0orTaMtfSYFllUcmiW9ZbgpZtlp0Ws0XsAGLbtoR2AMkc2SjSuCV02g4z8tgk9g0Re2AOiw0FnFmenkSAywPUFj6Tkljfpgs7PghJzyB9HywQCbxA2/9dgTwrHy8QqduZl6e9Ks5MYdGsxNB5WWzTzn5OsTXHCQ9yLfmcgimzc666quWpp2L9XdPuWacNrr2XT13BLLPbblxx/OYROaHfqxRSmLhMioI0wSjJ9I/IbfSj1SArWY02iqAI4zjZyCb/rz0SaIdLjpODHMAoidEUBdQoGugE/oI93wmMpRhgHMUC44E/UwLFARMpHpgEPEYuSgSfTC7wKZQMdEtMpRRgGrmNn8gjUadUYDp5gBmkA73AHymT0oFZlAH0AX+gLuQFdkUc/UDdyAfMluinLsZRyqGuwO4Se1A2sCf5gb2oO7A38HvKpR7APOoJzKdexnfUR2Jf6g3sR3nA/pRv/JMGSBxIfYCDJBZQX+BZ1A84mPoDC2mAcYQCNBBYRIOAQ6gAWAz8lkroLGApDQaWYfc8TEMpABxGRcDhNAR4tsRyKgaeQyXAEfjce4jOlTiShgJH0TDgaBpufENjJI6ls4Hj8BnoII2nEcAJEs+jc4EVNNL4B1XSKOBE4EE6n0aDr6KxwEk0DniBxMk03viaqmkCsIbOA04B/p2mUiVwGk0E1tL5wAupyviKpkuso0nAGXSBcYBmUjX4WRJnUw3wIpqC9otpKnCOxLk0zfiS5lEtcD5NB9ZLXEB1xhe0kGYAF9FM4CXAz2kxzQIuoYuAl9LFwMskLqU5wMtpLvAKmmfsp2USG6geuJwWAP9ACw3x/9qLgFdJvJouMfbRNbQYeC0tAV5HlwKvp8uMT6mRlgJvoMvRsgL4Kd1IVwBvomXAlbQcuAq4l/5IfwCupiuBN9NVxh66ReKtdDVwDV0LvI2uQ+/twD10B10PXEuNxm66k24A3kUrgH+SeDfdBFxHK4HraRXwHuAndC/9EXgfrQbeTzcDH6BbjI/pQbrV+IgeojXADXQb8GGJj9DtwEfpDuBjdCfwcYlP0F3AJ+lPwCDdDWwCfkjNtA7YQuuBG+le4wN6iu4z/kabJD5N9wNb6QHgZnoQuEXiM7QB+Cw9bLxPz9EjwD9L3EqPArfRY8C/0OPA5+kJ4Av0pPEevUhB4EvUZLxLL0v8KzUDX6EWYxe9ShuB2+kp4Gu0Cfg6PQ18A5+CdtGbtBm4Q+JO2gJ8i54Fvk3PGe/QO8C3aRf9GfgubQW+R9uMt+h9iX+j54Ef0AvAD+lF4EcSP6aXgJ/Qy8Dd9FdjJ+2RuJdeNXbQp7QduI9eA34mcT+9Dvyc3gB+QW8Cv6Sdxpt0QOJX9Bbw7/S28QZ9Te8A/yHxIO0CfkPvGa/TIXofeFjit/Q34BH6APhP+hD4ncTv6WPjNTpKnwB/oN3AH4Hb6SfaAzxGe4E/06fAXyQep8+MV6mN9gMN+hz4n5z+P5/Tv/2d5/Svzzinf/UvcvpXp+X0A/8ip395Wk7/4gxy+v4TOX3+STn9s3+R0z+TOf2z03L6PpnT93XK6ftkTt8nc/q+Tjn909Ny+l6Z0/fKnL73d5jTP/j/lNN3/Sen/yen/+5y+u/9nP77zen/6pz+n5z+n5z+6zn9ld9/Tv8/7yjp0QplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvVHlwZSAvRm9udERlc2NyaXB0b3IKL0ZvbnROYW1lIC9BQUFBQUErQXJpYWxNVAovRmxhZ3MgNAovQXNjZW50IDkwNS4yNzM0NAovRGVzY2VudCAtMjExLjkxNDA2Ci9TdGVtViA0NS44OTg0MzgKL0NhcEhlaWdodCA3MTUuODIwMzEKL0l0YWxpY0FuZ2xlIDAKL0ZvbnRCQm94IFstNjY0LjU1MDc4IC0zMjQuNzA3MDMgMjAwMCAxMDA1Ljg1OTM4XQovRm9udEZpbGUyIDggMCBSPj4KZW5kb2JqCjEwIDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0ZvbnREZXNjcmlwdG9yIDkgMCBSCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL1N1YnR5cGUgL0NJREZvbnRUeXBlMgovQ0lEVG9HSURNYXAgL0lkZW50aXR5Ci9DSURTeXN0ZW1JbmZvIDw8L1JlZ2lzdHJ5IChBZG9iZSkKL09yZGVyaW5nIChJZGVudGl0eSkKL1N1cHBsZW1lbnQgMD4+Ci9XIFswIFs3NTAgMCAwIDI3Ny44MzIwM10gNTUgWzYxMC44Mzk4NF0gNzEgNzIgNTU2LjE1MjM0IDczIFsyNzcuODMyMDNdIDgzIFs1NTYuMTUyMzQgMCAwIDUwMCAyNzcuODMyMDNdXQovRFcgMD4+CmVuZG9iagoxMSAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMjYyPj4gc3RyZWFtCnicXZHNasQgFIX3PsVdTheDTpKZoRACZUohi/7QtA9g9CYVGhVjFnn7+pOmUEHlcO539Cq9tY+tVh7omzOiQw+D0tLhbBYnEHoclSanAqQSflNpFRO3hAa4W2ePU6sHQ+oagL4Hd/ZuhcODND3eEfrqJDqlRzh83rqgu8Xab5xQe2CkaUDiEJKeuX3hEwJN2LGVwVd+PQbmr+JjtQhF0qd8G2EkzpYLdFyPSGoWRgP1UxgNQS3/+WWm+kF8cZeqy1DNWMGaqMprUucqqXP2riwlbUzxm7AfWGWouk/bZWMvOSl713KLyFC8V3y/vWmxOBf6TY+cGo0tKo37P1hjIxXnDxIJhhgKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUwCi9CYXNlRm9udCAvQUFBQUFBK0FyaWFsTVQKL0VuY29kaW5nIC9JZGVudGl0eS1ICi9EZXNjZW5kYW50Rm9udHMgWzEwIDAgUl0KL1RvVW5pY29kZSAxMSAwIFI+PgplbmRvYmoKeHJlZgowIDEyCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxNSAwMDAwMCBuIAowMDAwMDAwMzk3IDAwMDAwIG4gCjAwMDAwMDAxMDggMDAwMDAgbiAKMDAwMDAxMDgxMSAwMDAwMCBuIAowMDAwMDAwMTQ1IDAwMDAwIG4gCjAwMDAwMDA2MDUgMDAwMDAgbiAKMDAwMDAwMDY2MCAwMDAwMCBuIAowMDAwMDAwNzA3IDAwMDAwIG4gCjAwMDAwMDk5MzQgMDAwMDAgbiAKMDAwMDAxMDE2OCAwMDAwMCBuIAowMDAwMDEwNDc4IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxMgovUm9vdCA3IDAgUgovSW5mbyAxIDAgUj4+CnN0YXJ0eHJlZgoxMDk1MAolJUVPRg==",
                                "contentType": "application/pdf"
                            }
                        ],
                        "effectiveDateTime": "2024-02-25T15:12:12.837429",
                        "code": {
                            "coding": []
                        }
                    }
                }
            ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/diagnosticreport-operations/


----- BEGIN PAGE https://docs.canvasmedical.com/api/diagnosticreport/
### 
The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.   
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-diagnosticreport-lab.html>  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-diagnosticreport-note.html>  
This endpoint implements the US Core DiagnosticReport Profile for Report. The following USCDI data elements are retrievable from this endpoint:  
Clinical Notes:  
\- Imaging Narrative  
\- Laboratory Report Narrative  
\- Pathology Report Narrative  
\- Procedure Note  
Laboratory:  
\- Tests  
\- Values/Results
### Endpoints
get /DiagnosticReport/{id} get /DiagnosticReport
get
/DiagnosticReport/{id}
#### DiagnosticReport read
Read a DiagnosticReport resource
### Path Parameters
id required
string 
The unique identifier for the DiagnosticReport   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Diagnostic Report.
status 
enum [ final | entered-in-error ] 
Status of the Diagnostic Report see <https://hl7.org/fhir/R4/valueset-diagnostic-report-status.html>. Currently Canvas only supports two types of statuses.
category 
array[json] 
Service category <https://hl7.org/fhir/R4/valueset-diagnostic-service-sections.html>. Use this attribute to help distinguish the type of report in Canvas.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0074 
  - http://loinc.org 
code 
string 
The code of the category.
**Value Options Supported:**
  - LAB 
  - LP29684-5 
  - LP7839-6 
  - LP29708-2 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Laboratory 
  - Radiology 
  - Cardiology 
  - Pathology 
code 
json 
Name/Code for this diagnostic report.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the category.
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the Lab or Imaging Report.
subject 
json 
The subject of the report.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Health care event when test ordered or reviewed.   
Lab and Imaging Reports in Canvas will have an Encounter associated with the payload if there has been a Lab Results Review, Imaging Report Review, or a POC Lab Test command committed in a note on the patient's chart.
Click to view child attributes
reference 
string 
The reference string of the Encounter in the format of `"Encounter/912542cf-3bfb-4609-99f6-26ce94feb70d"`.
effectiveDateTime 
datetime | date 
Clinically relevant date/time for report.
issued 
datetime 
DateTime this version was made.
performer 
array[json] 
Responsible Diagnostic Service. In Canvas this will be the Practitioner who is assigned to the Report.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
result 
array[json] 
Observations associated with the Diagnostic Report.
Click to view child attributes
reference 
string 
The reference string of the observation in the format of `"Observation/dcc3239b-ffc9-4d02-9cb6-a486bb9d406e"`.
type 
string 
Type the reference refers to (e.g. "Observation").
presentedForm 
array[json] 
Entire report as issued. There is also a [DocumentReference](/api/documentreference) resource specifically for this Report PDF being created.
Click to view child attributes
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/DiagnosticReport
#### DiagnosticReport search
Search for DiagnosticReport resources
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier for a specific diagnostic report.
category 
string 
The DiagnosticReport category. Filters by the code and/or system under `category.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code`.
**Search Values Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0074|code
  - http://loinc.org|code
code 
string 
The DiagnosticReport code. Filters by the code and/or system under `code.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code`.
date 
date 
Filter by effectiveDateTime. See [Date Filtering](/api/date-filtering) for more information.
patient 
string 
The patient reference associated to the Diagnostic Report in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Diagnostic Report.
status 
enum [ final | entered-in-error ] 
Status of the Diagnostic Report see <https://hl7.org/fhir/R4/valueset-diagnostic-report-status.html>. Currently Canvas only supports two types of statuses.
category 
array[json] 
Service category <https://hl7.org/fhir/R4/valueset-diagnostic-service-sections.html>. Use this attribute to help distinguish the type of report in Canvas.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0074 
  - http://loinc.org 
code 
string 
The code of the category.
**Value Options Supported:**
  - LAB 
  - LP29684-5 
  - LP7839-6 
  - LP29708-2 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Laboratory 
  - Radiology 
  - Cardiology 
  - Pathology 
code 
json 
Name/Code for this diagnostic report.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the category.
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the Lab or Imaging Report.
subject 
json 
The subject of the report.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Health care event when test ordered or reviewed.   
Lab and Imaging Reports in Canvas will have an Encounter associated with the payload if there has been a Lab Results Review, Imaging Report Review, or a POC Lab Test command committed in a note on the patient's chart.
Click to view child attributes
reference 
string 
The reference string of the Encounter in the format of `"Encounter/912542cf-3bfb-4609-99f6-26ce94feb70d"`.
effectiveDateTime 
datetime | date 
Clinically relevant date/time for report.
issued 
datetime 
DateTime this version was made.
performer 
array[json] 
Responsible Diagnostic Service. In Canvas this will be the Practitioner who is assigned to the Report.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
result 
array[json] 
Observations associated with the Diagnostic Report.
Click to view child attributes
reference 
string 
The reference string of the observation in the format of `"Observation/dcc3239b-ffc9-4d02-9cb6-a486bb9d406e"`.
type 
string 
Type the reference refers to (e.g. "Observation").
presentedForm 
array[json] 
Entire report as issued. There is also a [DocumentReference](/api/documentreference) resource specifically for this Report PDF being created.
Click to view child attributes
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/DiagnosticReport/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DiagnosticReport/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "DiagnosticReport",
            "id": "9b90621b-059f-4f6e-9ef5-58171098e424",
            "status": "final",
            "category":
            [
                {
                    "coding":
                    [
                        {
                            "system": "http://loinc.org",
                            "code": "LP29684-5",
                            "display": "Radiology"
                        }
                    ]
                }
            ],
            "code":
            {
                "coding":
                [
                    {
                        "system": "http://www.ama-assn.org/go/cpt",
                        "code": "73562",
                        "display": "XRAY, knee; 3 views"
                    }
                ],
                "text": "XRAY, knee; 3 views"
            },
            "subject":
            {
                "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
                "type": "Patient"
            },
            "encounter":
            {
                "reference": "Encounter/6a077e6f-ead2-4af7-803d-0a203bedfb1c",
                "type": "Encounter"
            },
            "effectiveDateTime": "2023-08-22",
            "issued": "2023-08-22T21:35:01.909441+00:00",
            "performer":
            [
                {
                    "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                    "type": "Practitioner"
                }
            ],
            "presentedForm":
            [
                {
                    "url": "https://fumage-example.canvasmedical.com/DiagnosticReport/9b90621b-059f-4f6e-9ef5-58171098e424/files/presentedForm"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown DiagnosticReport resource '9b814d81-fb56-456b-a46d-c67fdaaec2ac'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/DiagnosticReport?patient=Patient/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DiagnosticReport?patient=Patient/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 2,
            "link":
            [
                {
                    "relation": "self",
                    "url": "/DiagnosticReport?patient=Patient/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/DiagnosticReport?patient=Patient/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/DiagnosticReport?patient=Patient/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0"
                }
            ],
            "entry":
            [
                {
                    "resource":
                    {
                        "resourceType": "DiagnosticReport",
                        "id": "197d1b7a-374e-4aa8-82b2-6960a62ecf7a",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                                        "code": "LAB",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "6690-2",
                                    "display": "WBC"
                                },
                                {
                                    "system": "http://loinc.org",
                                    "code": "785-6",
                                    "display": "MCH"
                                },
                                {
                                    "system": "http://loinc.org",
                                    "code": "5905-5",
                                    "display": "Monocytes"
                                }
                            ],
                            "text": "Complete Blood Count (Cbc) With Differential"
                        },
                        "subject": {
                            "reference": "Patient/ca52f2b76011429d8a0e4aa2b56b18bc",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2022-04-01T07:00:00+00:00",
                        "issued": "2022-04-15T15:24:22.522951+00:00",
                        "performer": [
                            {
                                "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                "type": "Practitioner"
                            }
                        ],
                        "result": [
                            {
                                "reference": "Observation/422f9f0f-151a-4488-bcad-ab4b0c3967da",
                                "type": "Observation"
                            }
                        ],
                        "presentedForm": [
                            {
                                "url": "https://fumage-example.canvasmedical.com/DiagnosticReport/197d1b7a-374e-4aa8-82b2-6960a62ecf7a/files/presentedForm"
                            }
                        ]
                    }
                },
                {
                    "resource":
                    {
                        "resourceType": "DiagnosticReport",
                        "id": "9b814d81-fb56-456b-a46d-c67fdaaec2ad",
                        "status": "final",
                        "category":
                        [
                            {
                                "coding":
                                [
                                    {
                                        "system": "http://loinc.org",
                                        "code": "LP29684-5",
                                        "display": "Radiology"
                                    }
                                ]
                            }
                        ],
                        "code":
                        {
                            "coding":
                            [
                                {
                                    "system": "http://www.ama-assn.org/go/cpt",
                                    "code": "73562",
                                    "display": "XRAY, knee; 3 views"
                                }
                            ]
                        },
                        "subject":
                        {
                            "reference": "Patient/ca52f2b76011429d8a0e4aa2b56b18bc",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2023-09-15",
                        "issued": "2023-09-15T19:52:56.711871+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/3640cd20de8a470aa570a852859ac87e",
                                "type": "Practitioner"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/diagnosticreport/


----- BEGIN PAGE https://docs.canvasmedical.com/api/documentreference/
### 
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html>  
A Document Reference can represent many different PDFs generated in Canvas:
  - A [Letter](https://canvas-medical.help.usepylon.com/articles/8181146406-letters) that has been faxed or printed from the patient's chart.
  - All documents uploaded via [Data Integration](https://help.canvasmedical.com/articles/7371085164-data-integration) and linked to a Patient. This includes Lab Reports, Imaging Reports, Referral Reports, Clinical, and Administrative Documents.
  - [POC Lab Commands](https://canvas-medical.help.usepylon.com/articles/7060961677-point-of-care-poc-tests) committed on the Patient's chart
  - [Clinical Notes](https://canvas-medical.help.usepylon.com/articles/1679996479-print-patient-chart) representing a PDF of each locked note. This also includes superseded versions on notes.
  - Any [Educational Material](https://canvas-medical.help.usepylon.com/articles/4966226408-educational-material-command) committed on a patient's chart.
  - Any [Invoices](https://help.canvasmedical.com/articles/9992348572-claim-management#invoicing-statements-128) generated for a patient.
### Endpoints
post /DocumentReference get /DocumentReference/{id} get /DocumentReference
post
/DocumentReference
#### DocumentReference create
Create DocumentReference with provided fields and values.
### Attributes
resourceType 
string 
The FHIR Resource name.
extension 
array[json] required
Specific FHIR extensions on this resource are supported to be able to map some Canvas specific attributes for a comment, clinical date, review mode, reviewer, priority, and if it requires a signature.
In order to identify which extension maps to specific fields in Canvas, the url field is used as an exact string match.  
**A few of the extensions are required:******
  - clinical-date
  - A reviewer is required, it can either be a practitioner or a group of practitioners. Provide one or the other, not both.
  - requires-signature
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-comment 
  - http://schemas.canvasmedical.com/fhir/document-reference-clinical-date 
  - http://schemas.canvasmedical.com/fhir/document-reference-review-mode 
  - http://schemas.canvasmedical.com/fhir/document-reference-reviewer 
  - http://schemas.canvasmedical.com/fhir/document-reference-reviewer-group 
  - http://schemas.canvasmedical.com/fhir/document-reference-priority 
  - http://schemas.canvasmedical.com/fhir/document-reference-requires-signature 
valueString 
string 
Value of extensions for Comment.
The `valueString` attribute is needed for the Comment's extension where the `url` is `http://schemas.canvasmedical.com/fhir/document-reference-comment`.  
Comment is a comment on the underlying Canvas document that is related to this DocumentReference resource.
valueCode 
string 
Value of extensions for Review Mode.
The `valueCode` attribute is needed for the Review Mode extension where the `url` is `http://schemas.canvasmedical.com/fhir/document-reference-review-mode`.   
Review Mode is a field on the underlying Canvas document record which determines the review mode values (`RR` for Review Required, `AR` for Already Reviewed and `RN` for Review Not Required).
**Value Options Supported:**
  - RR 
  - AR 
  - RN 
valueDate 
date required
Value of extension for Clinical Date.
The `valueDate` attribute is needed for the Clinical Date extension where the `url` is `http://schemas.canvasmedical.com/fhir/document-reference-clinical-date`. This attribute is required and determines the Clinical Date on the underlying document record related to this DocumentReference resource. It's the `original_date` field on the related Canvas document record. Expected date value format for this field is `YYYY-MM-DD`.
valueReference 
json required
Value of extension for Reviewer(s). The reviewer can be an individual practitioner and/or a group of practitioners.
The `valueReference` attribute is needed for expressing the Reviewer of the document where the `url` can be `http://schemas.canvasmedical.com/fhir/document-reference-reviewer` for an individual practitioner or `http://schemas.canvasmedical.com/fhir/document-reference-reviewer-group` for a group/team of practitioners. This attribute is required and will be the reference to the Practitioner (Canvas Staff) and/or Group (Canvas Team) that's assigned as the reviewer of this document.
Click to view child attributes
reference 
string required
The reference string of the Practitioner or Group in the format of `"Practitioner/95b9ac2d-e963-4d7a-b165-7901870f1663"` or `"Group/a6ae9198-19ba-4c27-b8e2-a8d5d3395b78"`.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "Group").
valueBoolean 
boolean required
Value of extensions for Priority and Requires Signature.
The `valueBoolean` attribute is needed for the Priority extension where the `url` is `http://schemas.canvasmedical.com/fhir/document-reference-priority` and for the Requires Signature where the `url` is `http://schemas.canvasmedical.com/fhir/document-reference-requires-signature`.   
Priority is a field on the underlying Canvas document that is related to this DocumentReference resource and determines if the document should be prioritized. If the priority is omitted from the request, it will default to False.   
Requires Signature is also a field on the underlying Canvas document that determines whether the related document requires Practitioner's signature.
status 
required
Status must be set to `current` on creation; the value has no further effect.
**Value Options Supported:**
  - current 
type 
json required
A coding for the type of document.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string required
The code value.
**Value Options Supported:**
  - 51852-2 (Letters) (read-only) 
  - 34895-3 (Educational Material) (read-only) 
  - 94093-2 (Invoices/Itemized Bill) (read-only) 
  - 53243-2 (Advance Beneficiary Notice) 
  - 42348-3 (Advance Directive / Living Will) 
  - 91983-7 (Care Management) 
  - 53245-7 (CDL (Commercial Driver License)) 
  - 96335-5 (Emergency Department Report) 
  - 11503-0 (External Medical Records) 
  - 75503-3 (Home Care Report) 
  - 34105-7 (Hospital Discharge Summary) 
  - 47039-3 (Hospital History & Physical) 
  - 64290-0 (Insurance Card) 
  - 52034-6 (Insurer Prior Authorization) 
  - 34113-1 (Nursing Home) 
  - 11504-8 (Operative Report) 
  - 80570-5 (Patient Agreement) 
  - 64285-0 (Patient Clinical Intake Form) 
  - 51848-0 (Physical Exams) 
  - 46209-3 (POLST (Provider Order for Life Sustaining-Treatment)) 
  - 64298-3 (Power of Attorney) 
  - 57833-6 (Prescription Refill Request) 
  - 34823-5 (Rehabilitation Report) 
  - 101904-1 (Release of Information Request) 
  - 34109-9 (Uncategorized Clinical Document) 
  - 51851-4 (Uncategorized Administrative Document) 
  - 52070-0 (Worker's Compensation Documents) 
category 
array[json] required
The categorization of the document.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-category 
code 
string required
The code value.
**Value Options Supported:**
  - patientadministrativedocument 
  - uncategorizedclinicaldocument 
subject 
json required
Who/what is the subject of the document.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
author 
array[json] 
Who and/or what authored the document.
Click to view child attributes
reference 
string required
The reference string of the author in the format of `"Practitioner/0e46396e-9cbc-48c6-94cc-f75f08b66c80"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
description 
string 
The title of the underlying Canvas Document related to this DocumentReference resource.
content 
array[json] required
Document referenced
Click to view child attributes
attachment 
json required
Where to access the document.  
Click to view child attributes
contentType 
string required
Mime type of the content, with charset etc.
data 
string required
Base64 encoded document file as a string.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/DocumentReference/{id}
#### DocumentReference read
Read DocumentReference resource.
### Path Parameters
id required
string 
The unique identifier for the DocumentReference   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the document reference.
identifier 
array[json] 
Other identifiers for the document.
Click to view child attributes
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-identifier 
value 
string 
The identifier value that is unique.
extension 
array[json] 
Specific FHIR extensions on this resource are supported to be able to map some Canvas specific attributes for a comment, clinical date, review mode, reviewer, priority, and if it requires a signature.
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-comment 
  - http://schemas.canvasmedical.com/fhir/document-reference-clinical-date 
  - http://schemas.canvasmedical.com/fhir/document-reference-review-mode 
  - http://schemas.canvasmedical.com/fhir/document-reference-reviewer 
  - http://schemas.canvasmedical.com/fhir/document-reference-reviewer-group 
  - http://schemas.canvasmedical.com/fhir/document-reference-priority 
  - http://schemas.canvasmedical.com/fhir/document-reference-requires-signature 
valueString 
string 
Value of extensions for Comment.
valueCode 
string 
Value of extensions for Review Mode.
**Value Options Supported:**
  - RR 
  - AR 
  - RN 
valueDate 
date 
Value of extension for Clinical Date.
valueReference 
json 
Value of extension for Reviewer(s). The reviewer can be an individual practitioner and/or a group of practitioners.
Click to view child attributes
reference 
string 
The reference string of the Practitioner or Group in the format of `"Practitioner/95b9ac2d-e963-4d7a-b165-7901870f1663"` or `"Group/a6ae9198-19ba-4c27-b8e2-a8d5d3395b78"`.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "Group").
valueBoolean 
boolean 
Value of extensions for Priority and Requires Signature.
status 
The status of the document reference.   
  - Letters and POC Lab Reports will always have a status of `current`.
  - Documents uploaded in Data Integration will have a status of `current` when created. If a document is removed from the patient's chart, it will have a status of `entered-in-error`.
  - For Clinical Note documents, the status will be `current` if it is the latest PDF of the locked note. If it is an older version due to a practitioner unlocking/ammending the note, the status will be `superseded`. If the note is deleted on the patient's chart, the status will be `entered-in-error`.
  - For Educational Material, the status will be `current` if the command is committed. If the command was entered-in-error in the chart, the status will also be `entered-in-error`.
  - For Invoices, the status will be `current` if it is a latest version or an adhoc invoice. The status will be `entered-in-error` if there was a problem generating or sending out the invoice to the patient. The status will be `superseded` if an automated invoice gets archived as it is older than the invoice interval defined Constance Config in Settings.
**Value Options Supported:**
  - current 
  - superseded 
  - entered-in-error 
type 
json 
A coding for the type of document.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string 
The code value.
**Value Options Supported:**
  - 51852-2 (Letters) (read-only) 
  - 34895-3 (Educational Material) (read-only) 
  - 94093-2 (Invoices/Itemized Bill) (read-only) 
  - 53243-2 (Advance Beneficiary Notice) 
  - 42348-3 (Advance Directive / Living Will) 
  - 91983-7 (Care Management) 
  - 53245-7 (CDL (Commercial Driver License)) 
  - 96335-5 (Emergency Department Report) 
  - 11503-0 (External Medical Records) 
  - 75503-3 (Home Care Report) 
  - 34105-7 (Hospital Discharge Summary) 
  - 47039-3 (Hospital History & Physical) 
  - 64290-0 (Insurance Card) 
  - 52034-6 (Insurer Prior Authorization) 
  - 34113-1 (Nursing Home) 
  - 11504-8 (Operative Report) 
  - 80570-5 (Patient Agreement) 
  - 64285-0 (Patient Clinical Intake Form) 
  - 51848-0 (Physical Exams) 
  - 46209-3 (POLST (Provider Order for Life Sustaining-Treatment)) 
  - 64298-3 (Power of Attorney) 
  - 57833-6 (Prescription Refill Request) 
  - 34823-5 (Rehabilitation Report) 
  - 101904-1 (Release of Information Request) 
  - 34109-9 (Uncategorized Clinical Document) 
  - 51851-4 (Uncategorized Administrative Document) 
  - 52070-0 (Worker's Compensation Documents) 
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the type of document.
category 
array[json] 
The categorization of the document. For non-administrative documents, the response also includes an additional `category` entry with system `http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category` and code `clinical-note` (for US Core compliance).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category 
code 
string 
The code value.
**Value Options Supported:**
  - clinical-note 
  - correspondence 
  - educationalmaterial 
  - imagingreport 
  - invoicefull 
  - labreport 
  - patientadministrativedocument 
  - referralreport 
  - uncategorizedclinicaldocument 
subject 
json 
Who/what is the subject of the document.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
date 
datetime 
When this document reference was created in Canvas.
author 
array[json] 
Who and/or what authored the document.
  - For letters, it is the practitioner who signed the letter determined by the practitioner dropdown in the UI when creating the letter.
  - For Lab Reports the author will be the practitioner who linked the report to the patient in Data Integration or if it the report has been reviewed, it will be the practitioner who committed a Lab Review. If the lab report that came through Health Gorilla was automtically linked to a Patient, there will be no author.
  - For POC Lab Reports, the author will be the practitioner who committed the command in the patient's chart.
  - For Clinical and Administrative submitted through Data Integration, the author will be the practitioner who linked the doc to the patient in Data Integration.
  - For Educational Material docs, the author will be the practitioner who originated the command on the patient's chart
  - For Invoices, the author will either be the practitioner who asked for the invoice when invoice was created adhoc or it will be Canvas Bot if the invoice was automtically generated.
  - There are no authors on Imaging Reports or Clinical Notes.
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/0e46396e-9cbc-48c6-94cc-f75f08b66c80"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
custodian 
json 
Organization which maintains the document.
Click to view child attributes
reference 
string 
The reference string of the custodian in the format of `"Organization/00000000-0000-0000-0002-000000000000"`.
type 
string 
Type the reference refers to (e.g. "Organization").
description 
string 
The title of the underlying Canvas Document related to this DocumentReference resource.
content 
array[json] 
Document referenced
Click to view child attributes
attachment 
json 
Where to access the document.  
Click to view child attributes
contentType 
string 
Mime type of the content, with charset etc.
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
format 
json 
Format/content rules for the document
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem 
code 
string 
The code value.
**Value Options Supported:**
  - urn:ihe:iti:xds:2017:mimeTypeSufficient 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - mimeType Sufficient 
context 
json 
Clinical context of document.   
  - For clinical note documents, the context will contain information about the encounter associated with the note if applicable.
  - For POC Lab Reports or Educational Material documents, the context will contain information about the encounter of the note the commands were committed with if applicable.
  - For Lab Reports that have a Lab Review committed in a note, the context will have information about any encounter associated with that note.
Click to view child attributes
encounter 
array[json] 
Context of the document content
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
period 
json 
Time of service that is being documented
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary of the encounter
end 
datetime 
End time with inclusive boundary, if not ongoing of the encounter
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/DocumentReference
#### DocumentReference search
Search for DocumentReference resources.
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier
category 
string 
Categorization of document. Filters by the code and/or system under `category.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g `http://schemas.canvasmedical.com/fhir/document-reference-category|labreport`).
date 
date or datetime 
Filter by the date or specific datetime the document was created. See [Date Filtering](/api/date-filtering) for more information.
patient 
string 
The patient reference associated to the document in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
status 
string 
The status of the document reference
**Search Values Supported:**
  - current
  - superseded
  - entered-in-error
subject 
string 
The patient reference associated to the document in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`. Can be used interchangeably with the patient parameter.
type 
string 
Kind of document (LOINC if possible). Filters by the code and/or system under `type.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g `http://loinc.org|11502-2`).
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the document reference.
identifier 
array[json] 
Other identifiers for the document.
Click to view child attributes
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-identifier 
value 
string 
The identifier value that is unique.
extension 
array[json] 
Specific FHIR extensions on this resource are supported to be able to map some Canvas specific attributes for a comment, clinical date, review mode, reviewer, priority, and if it requires a signature.
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-comment 
  - http://schemas.canvasmedical.com/fhir/document-reference-clinical-date 
  - http://schemas.canvasmedical.com/fhir/document-reference-review-mode 
  - http://schemas.canvasmedical.com/fhir/document-reference-reviewer 
  - http://schemas.canvasmedical.com/fhir/document-reference-reviewer-group 
  - http://schemas.canvasmedical.com/fhir/document-reference-priority 
  - http://schemas.canvasmedical.com/fhir/document-reference-requires-signature 
valueString 
string 
Value of extensions for Comment.
valueCode 
string 
Value of extensions for Review Mode.
**Value Options Supported:**
  - RR 
  - AR 
  - RN 
valueDate 
date 
Value of extension for Clinical Date.
valueReference 
json 
Value of extension for Reviewer(s). The reviewer can be an individual practitioner and/or a group of practitioners.
Click to view child attributes
reference 
string 
The reference string of the Practitioner or Group in the format of `"Practitioner/95b9ac2d-e963-4d7a-b165-7901870f1663"` or `"Group/a6ae9198-19ba-4c27-b8e2-a8d5d3395b78"`.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "Group").
valueBoolean 
boolean 
Value of extensions for Priority and Requires Signature.
status 
The status of the document reference.   
  - Letters and POC Lab Reports will always have a status of `current`.
  - Documents uploaded in Data Integration will have a status of `current` when created. If a document is removed from the patient's chart, it will have a status of `entered-in-error`.
  - For Clinical Note documents, the status will be `current` if it is the latest PDF of the locked note. If it is an older version due to a practitioner unlocking/ammending the note, the status will be `superseded`. If the note is deleted on the patient's chart, the status will be `entered-in-error`.
  - For Educational Material, the status will be `current` if the command is committed. If the command was entered-in-error in the chart, the status will also be `entered-in-error`.
  - For Invoices, the status will be `current` if it is a latest version or an adhoc invoice. The status will be `entered-in-error` if there was a problem generating or sending out the invoice to the patient. The status will be `superseded` if an automated invoice gets archived as it is older than the invoice interval defined Constance Config in Settings.
**Value Options Supported:**
  - current 
  - superseded 
  - entered-in-error 
type 
json 
A coding for the type of document.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string 
The code value.
**Value Options Supported:**
  - 51852-2 (Letters) (read-only) 
  - 34895-3 (Educational Material) (read-only) 
  - 94093-2 (Invoices/Itemized Bill) (read-only) 
  - 53243-2 (Advance Beneficiary Notice) 
  - 42348-3 (Advance Directive / Living Will) 
  - 91983-7 (Care Management) 
  - 53245-7 (CDL (Commercial Driver License)) 
  - 96335-5 (Emergency Department Report) 
  - 11503-0 (External Medical Records) 
  - 75503-3 (Home Care Report) 
  - 34105-7 (Hospital Discharge Summary) 
  - 47039-3 (Hospital History & Physical) 
  - 64290-0 (Insurance Card) 
  - 52034-6 (Insurer Prior Authorization) 
  - 34113-1 (Nursing Home) 
  - 11504-8 (Operative Report) 
  - 80570-5 (Patient Agreement) 
  - 64285-0 (Patient Clinical Intake Form) 
  - 51848-0 (Physical Exams) 
  - 46209-3 (POLST (Provider Order for Life Sustaining-Treatment)) 
  - 64298-3 (Power of Attorney) 
  - 57833-6 (Prescription Refill Request) 
  - 34823-5 (Rehabilitation Report) 
  - 101904-1 (Release of Information Request) 
  - 34109-9 (Uncategorized Clinical Document) 
  - 51851-4 (Uncategorized Administrative Document) 
  - 52070-0 (Worker's Compensation Documents) 
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the type of document.
category 
array[json] 
The categorization of the document. For non-administrative documents, the response also includes an additional `category` entry with system `http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category` and code `clinical-note` (for US Core compliance).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/document-reference-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category 
code 
string 
The code value.
**Value Options Supported:**
  - clinical-note 
  - correspondence 
  - educationalmaterial 
  - imagingreport 
  - invoicefull 
  - labreport 
  - patientadministrativedocument 
  - referralreport 
  - uncategorizedclinicaldocument 
subject 
json 
Who/what is the subject of the document.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
date 
datetime 
When this document reference was created in Canvas.
author 
array[json] 
Who and/or what authored the document.
  - For letters, it is the practitioner who signed the letter determined by the practitioner dropdown in the UI when creating the letter.
  - For Lab Reports the author will be the practitioner who linked the report to the patient in Data Integration or if it the report has been reviewed, it will be the practitioner who committed a Lab Review. If the lab report that came through Health Gorilla was automtically linked to a Patient, there will be no author.
  - For POC Lab Reports, the author will be the practitioner who committed the command in the patient's chart.
  - For Clinical and Administrative submitted through Data Integration, the author will be the practitioner who linked the doc to the patient in Data Integration.
  - For Educational Material docs, the author will be the practitioner who originated the command on the patient's chart
  - For Invoices, the author will either be the practitioner who asked for the invoice when invoice was created adhoc or it will be Canvas Bot if the invoice was automtically generated.
  - There are no authors on Imaging Reports or Clinical Notes.
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/0e46396e-9cbc-48c6-94cc-f75f08b66c80"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
custodian 
json 
Organization which maintains the document.
Click to view child attributes
reference 
string 
The reference string of the custodian in the format of `"Organization/00000000-0000-0000-0002-000000000000"`.
type 
string 
Type the reference refers to (e.g. "Organization").
description 
string 
The title of the underlying Canvas Document related to this DocumentReference resource.
content 
array[json] 
Document referenced
Click to view child attributes
attachment 
json 
Where to access the document.  
Click to view child attributes
contentType 
string 
Mime type of the content, with charset etc.
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
format 
json 
Format/content rules for the document
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem 
code 
string 
The code value.
**Value Options Supported:**
  - urn:ihe:iti:xds:2017:mimeTypeSufficient 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - mimeType Sufficient 
context 
json 
Clinical context of document.   
  - For clinical note documents, the context will contain information about the encounter associated with the note if applicable.
  - For POC Lab Reports or Educational Material documents, the context will contain information about the encounter of the note the commands were committed with if applicable.
  - For Lab Reports that have a Lab Review committed in a note, the context will have information about any encounter associated with that note.
Click to view child attributes
encounter 
array[json] 
Context of the document content
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
period 
json 
Time of service that is being documented
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary of the encounter
end 
datetime 
End time with inclusive boundary, if not ongoing of the encounter
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/DocumentReference' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
          {
            "resourceType": "DocumentReference",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                    "valueString": "Some comment on Document"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                    "valueDate": "2024-04-01"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                    "valueCode": "RN"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                    "valueReference": {
                        "reference": "Practitioner/5843991a8c934118ab4f424c839b340f",
                        "type": "Practitioner"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                    "valueBoolean": true
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-requires-signature",
                    "valueBoolean": true
                }
            ],
            "status": "current",
            "type": {
                "coding": [
                    {
                        "system": "http://loinc.org",
                        "code": "34105-7"
                    }
                ]
            },
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                            "code": "uncategorizedclinicaldocument"
                        }
                    ]
                }
            ],
            "subject": {
                "reference": "Patient/aabcf98215eb4356ad773a0ec9cd3369",
                "type": "Patient"
            },
            "author": [
                {
                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                    "type": "Practitioner"
                }
            ],
            "description": "Hospital Discharge Summary",
            "content": [
                {
                    "attachment": {
                        "contentType": "application/pdf",
                        "data": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyAzMiBUZiggIFlPVVIgVEVYVCBIRVJFICAgKScgRVQKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8Ci9UeXBlIC9QYWdlCi9QYXJlbnQgNSAwIFIKL0NvbnRlbnRzIDkgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwovTWVkaWFCb3ggWyAwIDAgMjUwIDUwIF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
                    }
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DocumentReference"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json",
        }
        payload = {
            "resourceType": "DocumentReference",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                    "valueString": "Some comment on Document",
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                    "valueDate": "2024-04-01",
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                    "valueCode": "RN",
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                    "valueReference": {
                        "reference": "Practitioner/5843991a8c934118ab4f424c839b340f",
                        "type": "Practitioner",
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                    "valueBoolean": True,
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-requires-signature",
                    "valueBoolean": True,
                }
            ],
            "status": "current",
            "type": {
                "coding": [
                    {
                        "system": "http://loinc.org",
                        "code": "34105-7",
                    }
                ]
            },
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                            "code": "uncategorizedclinicaldocument",
                        }
                    ]
                }
            ],
            "subject": {
                "reference": "Patient/aabcf98215eb4356ad773a0ec9cd3369",
                "type": "Patient",
            },
            "author": [
                {
                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                    "type": "Practitioner",
                }
            ],
            "description": "Hospital Discharge Summary",
            "content": [
                {
                    "attachment": {
                        "contentType": "application/pdf",
                        "data": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyAzMiBUZiggIFlPVVIgVEVYVCBIRVJFICAgKScgRVQKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8Ci9UeXBlIC9QYWdlCi9QYXJlbnQgNSAwIFIKL0NvbnRlbnRzIDkgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwovTWVkaWFCb3ggWyAwIDAgMjUwIDUwIF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G",
                    }
                }
            ]
        }
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/DocumentReference/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DocumentReference/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "DocumentReference",
            "id": "6f60ed1c-a6b3-4791-99f0-f618704e33d1",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                    "valueString": "Some comment on Document"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                    "valueDate": "2024-04-01"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                    "valueCode": "RN"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                    "valueReference": {
                        "reference": "Practitioner/5843991a8c934118ab4f424c839b340f",
                        "type": "Practitioner"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                    "valueBoolean": true
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/document-reference-requires-signature",
                    "valueBoolean": true
                }
            ],
            "status": "current",
            "type": {
                "coding": [
                    {
                        "system": "http://loinc.org",
                        "code": "34105-7",
                        "display": "Hospital Discharge summary"
                    }
                ]
            },
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                            "code": "uncategorizedclinicaldocument"
                        }
                    ]
                },
                {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
                            "code": "clinical-note"
                        }
                    ]
                }
            ],
            "subject": {
                "reference": "Patient/aabcf98215eb4356ad773a0ec9cd3369",
                "type": "Patient"
            },
            "date": "2024-04-22T00:00:00+00:00",
            "author": [
                {
                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                    "type": "Practitioner"
                }
            ],
            "custodian": {
                "reference": "Organization/00000000-0000-0000-0002-000000000000",
                "type": "Organization"
            },
            "description": "Hospital Discharge Summary",
            "content": [
                {
                    "attachment": {
                        "contentType": "application/pdf",
                        "url": "https://fumage-example.canvasmedical.com/DocumentReference/6f60ed1c-a6b3-4791-99f0-f618704e33d1/files/content"
                    },
                    "format": {
                        "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                        "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                        "display": "mimeType Sufficient"
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown DocumentReference resource '9b814d81-fb56-456b-a46d-c67fdaaec2ac'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/DocumentReference?subject=Patient/cfd91cd3bd9046db81199aa8ee4afd7f&status=current&type=http://loinc.org|11502-2' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/DocumentReference?subject=Patient/cfd91cd3bd9046db81199aa8ee4afd7f&status=current&type=http://loinc.org|11502-2"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 12,
            "link": [
                {
                    "relation": "self",
                    "url": "/DocumentReference?subject=Patient%2Fcfd91cd3bd9046db81199aa8ee4afd7f&status=current&type=http%3A%2F%2Floinc.org%7C11502-2&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/DocumentReference?subject=Patient%2Fcfd91cd3bd9046db81199aa8ee4afd7f&status=current&type=http%3A%2F%2Floinc.org%7C11502-2&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/DocumentReference?subject=Patient%2Fcfd91cd3bd9046db81199aa8ee4afd7f&status=current&type=http%3A%2F%2Floinc.org%7C11502-2&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "4b640065-ae64-4775-b5a8-8264314cf5fc",
                        "status": "current",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "94093-2",
                                    "display": "Itemized bill"
                                }
                            ],
                            "text": "Itemized bill"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "invoicefull"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-24T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Itemized bill",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/4b640065-ae64-4775-b5a8-8264314cf5fc/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "5a0cf7ae-bd88-4f04-bd7e-60a33e5e2824",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                                "valueString": "Some comment on LabReport Document"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                                "valueDate": "2024-04-02"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                                "valueCode": "AR"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                                "valueReference": {
                                    "reference": "Practitioner/5843991a8c934118ab4f424c839b340f",
                                    "type": "Practitioner"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer-group",
                                "valueReference": {
                                    "reference": "Group/a6ae9198-19ba-4c27-b8e2-a8d5d3395b78",
                                    "type": "Group"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-requires-signature",
                                "valueBoolean": true
                            }
                        ],
                        "status": "current",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "11502-2",
                                    "display": "Laboratory report"
                                }
                            ],
                            "text": "Laboratory report"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "labreport"
                                    }
                                ]
                            },
                            {
                                "coding": [
                                    {
                                        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
                                        "code": "clinical-note"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-04-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Lab Report",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/5a0cf7ae-bd88-4f04-bd7e-60a33e5e2824/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ],
                        "context": {
                            "encounter": [
                                {
                                    "reference": "Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9",
                                    "type": "Encounter"
                                }
                            ],
                            "period": {
                                "start": "2024-02-22T23:10:12.409838+00:00"
                            }
                        }
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "b9f82cd0-6644-4b3f-a9d1-7585c3e71498",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                                "valueString": "Some comment on ImagingReport Document"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                                "valueDate": "2024-04-03"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                                "valueCode": "RN"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                                "valueReference": {
                                    "reference": "Practitioner/5843991a8c934118ab4f424c839b340f",
                                    "type": "Practitioner"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-requires-signature",
                                "valueBoolean": true
                            }
                        ],
                        "status": "entered-in-error",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "18748-4",
                                    "display": "Diagnostic imaging study"
                                }
                            ],
                            "text": "Diagnostic imaging study"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "imagingreport"
                                    }
                                ]
                            },
                            {
                                "coding": [
                                    {
                                        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
                                        "code": "clinical-note"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-04-21T00:00:00+00:00",
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Imaging Report",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/b9f82cd0-6644-4b3f-a9d1-7585c3e71498/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "51a49fef-eb67-4b8d-a992-b3dd9e754dea",
                        "status": "current",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "51852-2",
                                    "display": "Letter"
                                }
                            ],
                            "text": "Letter"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "correspondence"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-21T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Letter",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/51a49fef-eb67-4b8d-a992-b3dd9e754dea/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "713394da-f250-4c59-8b47-96458155f687",
                        "status": "entered-in-error",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "clinical-note"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/713394da-f250-4c59-8b47-96458155f687/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ],
                        "description": "Lab visit",
                        "context": {
                            "encounter": [
                                {
                                    "reference": "Encounter/aaefb326-8601-4c03-84d4-d6151b3a96bf",
                                    "type": "Encounter"
                                }
                            ],
                            "period": {
                                "start": "2024-02-21T21:52:42.777590+00:00",
                                "end": "2024-02-22T19:37:10.850120+00:00"
                            }
                        }
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "6ebf590d-ff90-412e-a5e7-9be30d6e4c35",
                        "status": "current",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "11488-4",
                                    "display": "Consult note"
                                }
                            ],
                            "text": "Consult note"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "referralreport"
                                    }
                                ]
                            },
                            {
                                "coding": [
                                    {
                                        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
                                        "code": "clinical-note"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Consultancy Report",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/6ebf590d-ff90-412e-a5e7-9be30d6e4c35/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "d9a1304d-159d-4518-be88-3f9a1ea93cd1",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                                "valueString": "Disability form comment"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                                "valueDate": "2023-12-12"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                                "valueCode": "RN"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                                "valueReference": {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                                "valueBoolean": false
                            }
                        ],
                        "status": "current",
                        "type": {
                            "text": "Disability Form"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "patientadministrativedocument"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Disability Form",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/d9a1304d-159d-4518-be88-3f9a1ea93cd1/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "bce56cc4-268a-4562-a699-16e8869415ad",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                                "valueString": "Hospital discharge summary comment"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                                "valueDate": "2024-01-14"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                                "valueCode": "AR"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                                "valueReference": {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                                "valueBoolean": true
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-requires-signature",
                                "valueBoolean": false
                            }
                        ],
                        "status": "current",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "34105-7",
                                    "display": "Hospital Discharge summary"
                                }
                            ],
                            "text": "Hospital Discharge summary"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "uncategorizedclinicaldocument"
                                    }
                                ]
                            },
                            {
                                "coding": [
                                    {
                                        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
                                        "code": "clinical-note"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/fdb06c59cecd43d095884222fcd93717",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Hospital Discharge Summary",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/bce56cc4-268a-4562-a699-16e8869415ad/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "d220fa24-2b2f-44cf-9843-5a1b681f0805",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                                "valueString": "Advance beneficiary comment"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                                "valueDate": "2024-02-13"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                                "valueCode": "RN"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                                "valueReference": {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                                "valueBoolean": true
                            }
                        ],
                        "status": "current",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "53243-2",
                                    "display": "Advanced beneficiary notice"
                                }
                            ],
                            "text": "Advanced beneficiary notice"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "patientadministrativedocument"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Advanced Beneficiary Notice",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/d220fa24-2b2f-44cf-9843-5a1b681f0805/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "04a71b54-89b0-49bf-96be-60b5bdfa6450",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                                "valueString": "Handicap Parking Permit comment"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                                "valueDate": "2024-04-01"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                                "valueCode": "RN"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                                "valueReference": {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                                "valueBoolean": true
                            }
                        ],
                        "status": "current",
                        "type": {
                            "text": "Handicap Parking Permit"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "patientadministrativedocument"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Handicap Parking Permit",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/04a71b54-89b0-49bf-96be-60b5bdfa6450/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "efe6c0d6-97c0-42a6-91ba-926a2dc3c66f",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-comment",
                                "valueString": "Disability form comment"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-clinical-date",
                                "valueDate": "2024-01-15"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-review-mode",
                                "valueCode": "RN"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-reviewer",
                                "valueReference": {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/document-reference-priority",
                                "valueBoolean": false
                            }
                        ],
                        "status": "current",
                        "type": {
                            "text": "Disability Form"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "patientadministrativedocument"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Disability Form",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/efe6c0d6-97c0-42a6-91ba-926a2dc3c66f/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "DocumentReference",
                        "id": "380ad499-ec8f-4f1f-b1f0-5f25b04fd574",
                        "status": "current",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "34895-3",
                                    "display": "Education note"
                                }
                            ],
                            "text": "Education note"
                        },
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/document-reference-category",
                                        "code": "educationalmaterial"
                                    }
                                ]
                            },
                            {
                                "coding": [
                                    {
                                        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
                                        "code": "clinical-note"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/c0df2c04a0e64b46ba7fe3f836068e49",
                            "type": "Patient"
                        },
                        "date": "2024-02-22T00:00:00+00:00",
                        "author": [
                            {
                                "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                "type": "Practitioner"
                            }
                        ],
                        "custodian": {
                            "reference": "Organization/00000000-0000-0000-0002-000000000000",
                            "type": "Organization"
                        },
                        "description": "Making a birth plan",
                        "content": [
                            {
                                "attachment": {
                                    "contentType": "application/pdf",
                                    "url": "https://fumage-example.canvasmedical.com/DocumentReference/380ad499-ec8f-4f1f-b1f0-5f25b04fd574/files/content"
                                },
                                "format": {
                                    "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                                    "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                                    "display": "mimeType Sufficient"
                                }
                            }
                        ],
                        "context": {
                            "encounter": [
                                {
                                    "reference": "Encounter/879b35fd-3bc2-4ccd-98d7-954dd9b6d0a9",
                                    "type": "Encounter"
                                }
                            ],
                            "period": {
                                "start": "2024-02-22T23:10:12.409838+00:00"
                            }
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/documentreference/


----- BEGIN PAGE https://docs.canvasmedical.com/api/encounter/
### 
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html>  
**Encounter creation in Canvas**  
An encounter is associated with some of our notes in Canvas. For our default base notes, an encounter will be created with these note types:   
\- Lab visit   
\- Phone visit   
\- Telehealth visit   
\- Office visit   
\- Home Visit   
\- In-patient Visit   
With our [Configurable Note Types Feature](https://help.canvasmedical.com/articles/6785045644-appointment-event-note-types) all custom note types will be associated with an encounter by default.
### Endpoints
get /Encounter/{id} get /Encounter
get
/Encounter/{id}
#### Encounter read
Read an Encounter resource
### Path Parameters
id required
string 
The unique identifier for the Encounter   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the encounter.
extension 
array[json] 
Canvas supports a note identifier extension on this resource for read and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
identifier 
array[json] 
Identifier(s) by which this encounter is known.
Click to view child attributes
id 
string 
The identifier of the encounter.
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://canvasmedical.com 
value 
string 
The value that is unique.
status 
enum [ planned | cancelled | finished | in-progress ] 
The status of the encounter.   
\- A `planned` encounter is an Appointment note that has not been check-in.   
\- A `cancelled` encounter is either 1) an Appointment that was cancelled or no-showed or 2) a Note that was deleted from the patient's chart.   
\- A `finished` encounter is a Note that has been locked at least once. Notes that are in an unlocked/ammended state, will have a finished status; however, they will not have a period.end datetime.   
\- An `in-progress` encounter is a note that has not yet been locked.
class 
json 
Classification of patient encounter.
Click to view child attributes
system 
string 
Identity of the terminology system.
**Value Options Supported:**
  - https://www.hl7.org/fhir/v3/ActEncounterCode/vs.html 
code 
string 
Symbol in syntax defined by the system.
display 
string 
Representation defined by the system.
type 
array[json] 
Specific type of encounter.   
In Canvas this will represent the Note Type the encounter is associated with. If the Note is in a `planned` status, the coding will correspond to Canvas' appointment note type until the note is checked-in and converted to the scheduled note type.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code.
display 
string 
The display name of the coding.
subject 
json 
The patient or group present at the encounter.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
participant 
array[json] 
List of participants involved in the encounter. Participants may include Practitioner references and RelatedPerson references for patient contacts associated with the encounter.
Click to view child attributes
type 
array[json] 
Role of participant in encounter.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-ParticipationType 
code 
string 
The code.
**Value Options Supported:**
  - PART 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Participation 
period 
json 
Period of time during the encounter that the participant participated
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary.
end 
datetime 
End time with inclusive boundary, if not ongoing.
individual 
json 
Persons involved in the encounter other than the patient. May reference a Practitioner or a RelatedPerson.
Click to view child attributes
reference 
string 
The reference string of the participant in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"` or `"RelatedPerson/3fcea5ee-8961-43b4-9d47-3e8a2a625e95"`.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "RelatedPerson").
display 
string 
Text alternative for the resource (e.g Credendialed name of the Practitioner).
appointment 
array[json] 
The appointment that scheduled this encounter if applicable. If an appointment was rescheduled at any point within the Canvas UI, there may be multiple appointments in this array.
Click to view child attributes
reference 
string 
The reference string of the appointment in the format of `"Appointment/79f99d7d-2e55-41ec-8e39-01bd9408aacf"`.
type 
string 
Type the reference refers to (e.g. "Appointment").
period 
json 
The start and end time of the encounter.   
Appointment notes in Canvas will not have a period until the note is checked-in.   
Encounter notes will not have period.end datetime until the note is locked/signed.   
Notes that are in an unlocked/ammended state, will not have a period.end datetime until relocked/signed.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary.
end 
datetime 
End time with inclusive boundary, if not ongoing.
reasonCode 
array[json] 
Coded reason the encounter takes place.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://snomed.info/sct 
code 
string 
The code.
**Value Options Supported:**
  - 308335008 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Patient encounter procedure (procedure) 
reasonReference 
array[json] 
Reason the encounter takes place (reference).   
In Canvas this represents the conditions that were **created** during the encounter, via the Diagnose command or another command that creates a condition.   
This list does **not** include conditions that were only assessed during the encounter. An Assess command records an assessment against a condition that already exists in the chart, and it does not change which encounter that condition belongs to, so an encounter whose only condition activity was an Assess returns an empty `reasonReference`. To retrieve the conditions assessed during an encounter, use the [Assessment](/sdk/data-assessment) model in the Canvas SDK, which links each assessment to both the note it was documented on and the condition it assessed. For the diagnoses associated with a billed service, use `diagnosis` and `item.diagnosisSequence` on the [Claim](/api/claim) resource.
Click to view child attributes
reference 
string 
The reference string of the condition in the format of `"Condition/e8921649-ec92-46b5-b663-8a4097c10513"`.
type 
string 
Type the reference refers to (e.g. "Condition").
hospitalization 
json 
Details about the admission to a healthcare service.
Click to view child attributes
dischargeDisposition 
json 
Category or kind of location after discharge.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/discharge-disposition 
code 
string 
The code.
**Value Options Supported:**
  - oth 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Other 
location 
array[json] 
List of locations where the patient has been during the encounter.
Click to view child attributes
location 
json 
Location the encounter takes place.
Click to view child attributes
reference 
string 
The reference string of the location in the format of `"Location/3c01c6ea-b7dc-4109-9d1c-1cf4ba7c211e"`.
type 
string 
Type the reference refers to (e.g. "Location").
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Encounter
#### Encounter search
Search for Encounter resources
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier for a specific encounter.
appointment 
string 
The appointment that scheduled this encounter in the format `Appointment/6e5234c4-2dd0-495d-98cf-ad04add1316e`.
date 
string 
Filter by period.start time. See [Date Filtering](/api/date-filtering) for more information.
patient 
string 
The patient or group present at the encounter in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
subject 
string 
Encounter subject in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the encounter.
extension 
array[json] 
Canvas supports a note identifier extension on this resource for read and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
identifier 
array[json] 
Identifier(s) by which this encounter is known.
Click to view child attributes
id 
string 
The identifier of the encounter.
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://canvasmedical.com 
value 
string 
The value that is unique.
status 
enum [ planned | cancelled | finished | in-progress ] 
The status of the encounter.   
\- A `planned` encounter is an Appointment note that has not been check-in.   
\- A `cancelled` encounter is either 1) an Appointment that was cancelled or no-showed or 2) a Note that was deleted from the patient's chart.   
\- A `finished` encounter is a Note that has been locked at least once. Notes that are in an unlocked/ammended state, will have a finished status; however, they will not have a period.end datetime.   
\- An `in-progress` encounter is a note that has not yet been locked.
class 
json 
Classification of patient encounter.
Click to view child attributes
system 
string 
Identity of the terminology system.
**Value Options Supported:**
  - https://www.hl7.org/fhir/v3/ActEncounterCode/vs.html 
code 
string 
Symbol in syntax defined by the system.
display 
string 
Representation defined by the system.
type 
array[json] 
Specific type of encounter.   
In Canvas this will represent the Note Type the encounter is associated with. If the Note is in a `planned` status, the coding will correspond to Canvas' appointment note type until the note is checked-in and converted to the scheduled note type.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code.
display 
string 
The display name of the coding.
subject 
json 
The patient or group present at the encounter.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
participant 
array[json] 
List of participants involved in the encounter. Participants may include Practitioner references and RelatedPerson references for patient contacts associated with the encounter.
Click to view child attributes
type 
array[json] 
Role of participant in encounter.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-ParticipationType 
code 
string 
The code.
**Value Options Supported:**
  - PART 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Participation 
period 
json 
Period of time during the encounter that the participant participated
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary.
end 
datetime 
End time with inclusive boundary, if not ongoing.
individual 
json 
Persons involved in the encounter other than the patient. May reference a Practitioner or a RelatedPerson.
Click to view child attributes
reference 
string 
The reference string of the participant in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"` or `"RelatedPerson/3fcea5ee-8961-43b4-9d47-3e8a2a625e95"`.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "RelatedPerson").
display 
string 
Text alternative for the resource (e.g Credendialed name of the Practitioner).
appointment 
array[json] 
The appointment that scheduled this encounter if applicable. If an appointment was rescheduled at any point within the Canvas UI, there may be multiple appointments in this array.
Click to view child attributes
reference 
string 
The reference string of the appointment in the format of `"Appointment/79f99d7d-2e55-41ec-8e39-01bd9408aacf"`.
type 
string 
Type the reference refers to (e.g. "Appointment").
period 
json 
The start and end time of the encounter.   
Appointment notes in Canvas will not have a period until the note is checked-in.   
Encounter notes will not have period.end datetime until the note is locked/signed.   
Notes that are in an unlocked/ammended state, will not have a period.end datetime until relocked/signed.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary.
end 
datetime 
End time with inclusive boundary, if not ongoing.
reasonCode 
array[json] 
Coded reason the encounter takes place.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://snomed.info/sct 
code 
string 
The code.
**Value Options Supported:**
  - 308335008 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Patient encounter procedure (procedure) 
reasonReference 
array[json] 
Reason the encounter takes place (reference).   
In Canvas this represents the conditions that were **created** during the encounter, via the Diagnose command or another command that creates a condition.   
This list does **not** include conditions that were only assessed during the encounter. An Assess command records an assessment against a condition that already exists in the chart, and it does not change which encounter that condition belongs to, so an encounter whose only condition activity was an Assess returns an empty `reasonReference`. To retrieve the conditions assessed during an encounter, use the [Assessment](/sdk/data-assessment) model in the Canvas SDK, which links each assessment to both the note it was documented on and the condition it assessed. For the diagnoses associated with a billed service, use `diagnosis` and `item.diagnosisSequence` on the [Claim](/api/claim) resource.
Click to view child attributes
reference 
string 
The reference string of the condition in the format of `"Condition/e8921649-ec92-46b5-b663-8a4097c10513"`.
type 
string 
Type the reference refers to (e.g. "Condition").
hospitalization 
json 
Details about the admission to a healthcare service.
Click to view child attributes
dischargeDisposition 
json 
Category or kind of location after discharge.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/discharge-disposition 
code 
string 
The code.
**Value Options Supported:**
  - oth 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Other 
location 
array[json] 
List of locations where the patient has been during the encounter.
Click to view child attributes
location 
json 
Location the encounter takes place.
Click to view child attributes
reference 
string 
The reference string of the location in the format of `"Location/3c01c6ea-b7dc-4109-9d1c-1cf4ba7c211e"`.
type 
string 
Type the reference refers to (e.g. "Location").
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Encounter/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Encounter/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Encounter",
            "id": "7720a218-c0bd-4cee-82a2-729bd9c101f3",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "identifier": [
                {
                    "id": "7720a218-c0bd-4cee-82a2-729bd9c101f3",
                    "system": "http://canvasmedical.com",
                    "value": "7720a218-c0bd-4cee-82a2-729bd9c101f3"
                }
            ],
            "status": "in-progress",
            "class": {
                "system": "https://www.hl7.org/fhir/v3/ActEncounterCode/vs.html"
            },
            "type": [
                {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "308335008",
                            "display": "Office Visit"
                        }
                    ]
                }
            ],
            "subject": {
                "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
                "type": "Patient"
            },
            "participant": [
                {
                    "type": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                                    "code": "PART",
                                    "display": "Participation"
                                }
                            ]
                        }
                    ],
                    "period": {
                        "start": "2022-04-04T05:26:34.711718+00:00"
                    },
                    "individual": {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner",
                        "display": "Canvas Support MD"
                    }
                }
            ],
            "period": {
                "start": "2022-04-04T05:26:34.711718+00:00"
            },
            "reasonCode": [
                {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "308335008",
                            "display": "Patient encounter procedure (procedure)"
                        }
                    ]
                }
            ],
            "reasonReference": [
                {
                    "reference": "Condition/b06982fa-9bcb-4695-a2f4-09cfdb21f03d",
                    "type": "Condition"
                },
                {
                    "reference": "Condition/e3df5e12-8ea4-46f8-922e-89a229945ef4",
                    "type": "Condition"
                },
                {
                    "reference": "Condition/266eae2b-4983-42b7-94ca-1397f80a7968",
                    "type": "Condition"
                }
            ],
            "hospitalization": {
                "dischargeDisposition": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
                            "code": "oth",
                            "display": "Other"
                        }
                    ]
                }
            },
            "location": [
                {
                    "location": {
                        "reference": "Location/50ea08f9-f4a5-4315-90e3-10d38922daa8",
                        "type": "Location"
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
            "resourceType": "OperationOutcome",
            "issue": [
                {
                    "severity": "error",
                    "code": "not-found",
                    "details": {
                        "text": "Unknown Encounter resource '7d1ce256fcd7408193b0459650937a07'"
                    }
                }
            ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Encounter?patient=Patient/8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Encounter?patient=Patient/8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Encounter?patient=Patient/8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Encounter?patient=Patient/8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Encounter?patient=Patient/8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Encounter",
                        "id": "06e0ee68-59f8-4899-b906-1298a36870ab",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                                "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                            }
                        ],
                        "identifier": [
                            {
                                "id": "06e0ee68-59f8-4899-b906-1298a36870ab",
                                "system": "http://canvasmedical.com",
                                "value": "06e0ee68-59f8-4899-b906-1298a36870ab"
                            }
                        ],
                        "status": "finished",
                        "class": {
                            "system": "https://www.hl7.org/fhir/v3/ActEncounterCode/vs.html"
                        },
                        "type": [
                            {
                                "coding": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "308335008",
                                        "display": "Office Visit"
                                    }
                                ]
                            }
                        ],
                        "subject": {
                            "reference": "Patient/8f19219e36054ea89c4d98c9b258c2f1",
                            "type": "Patient"
                        },
                        "participant": [
                            {
                                "type": [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                                                "code": "PART",
                                                "display": "Participation"
                                            }
                                        ]
                                    }
                                ],
                                "period": {
                                    "start": "2023-09-20T18:41:54.885110+00:00",
                                    "end": "2023-09-20T18:57:47.490741+00:00"
                                },
                                "individual": {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner",
                                    "display": "Larry Weed"
                                }
                            }
                        ],
                        "period": {
                            "start": "2023-09-20T18:41:54.885110+00:00",
                            "end": "2023-09-20T18:57:47.490741+00:00"
                        },
                        "reasonCode": [
                            {
                                "coding": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "308335008",
                                        "display": "Patient encounter procedure (procedure)"
                                    }
                                ]
                            }
                        ],
                        "reasonReference": [
                            {
                                "reference": "Condition/82e02680-c37d-4705-876d-b845d85efc20",
                                "type": "Condition"
                            }
                        ],
                        "hospitalization": {
                            "dischargeDisposition": {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
                                        "code": "oth",
                                        "display": "Other"
                                    }
                                ]
                            }
                        },
                        "location": [
                            {
                                "location": {
                                    "reference": "Location/e332ff73-7fa4-4432-abe9-2adc43b1bb2c",
                                    "type": "Location"
                                }
                            }
                        ]
                    }
                },
                {
                    "resourceType": "Encounter",
                    "id": "f7663d7b-13bd-4236-843e-086306aea125",
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                            "valueId": "8c83a639-05c0-43e8-a39b-8b99ea75d7d2"
                        }
                    ],
                    "identifier": [
                        {
                            "id": "f7663d7b-13bd-4236-843e-086306aea125",
                            "system": "http://canvasmedical.com",
                            "value": "f7663d7b-13bd-4236-843e-086306aea125"
                        }
                    ],
                    "status": "planned",
                    "class": {
                        "system": "https://www.hl7.org/fhir/v3/ActEncounterCode/vs.html"
                    },
                    "type": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "185418009",
                                    "display": "Method appointment made"
                                }
                            ]
                        }
                    ],
                    "subject": {
                        "reference": "Patient/8f19219e36054ea89c4d98c9b258c2f1",
                        "type": "Patient"
                    },
                    "participant": [
                        {
                            "type": [
                                {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                                            "code": "PART",
                                            "display": "Participation"
                                        }
                                    ]
                                }
                            ],
                            "individual": {
                                "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                "type": "Practitioner",
                                "display": "Canvas Support MD"
                            }
                        }
                    ],
                    "appointment": [
                        {
                            "reference": "Appointment/65463607-866c-4c6f-812f-bf8616a5f755",
                            "type": "Appointment"
                        },
                        {
                            "reference": "Appointment/6e5234c4-2dd0-495d-98cf-ad04add1316e",
                            "type": "Appointment"
                        }
                    ],
                    "reasonCode": [
                        {
                            "coding": [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "308335008",
                                    "display": "Patient encounter procedure (procedure)"
                                }
                            ]
                        }
                    ],
                    "hospitalization": {
                        "dischargeDisposition": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
                                    "code": "oth",
                                    "display": "Other"
                                }
                            ]
                        }
                    },
                    "location": [
                        {
                            "location": {
                                "reference": "Location/b3476a18-3f63-422d-87e7-b3dc0cd55060",
                                "type": "Location"
                            }
                        }
                    ]
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/encounter/


----- BEGIN PAGE https://docs.canvasmedical.com/api/errors/
Canvas uses conventional HTTP response codes to indicate success or failure of an API request. In general: Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a request wasn't found, etc.). Codes in the `5xx` range indicate an error with Canvas' server.
All `4xx` errors that could be handled programmatically (e.g., resource not found) include an [OperationOutcome](https://www.hl7.org/fhir/operationoutcome.html) that explains the error reported
Error Code | Description  
---|---  
200 - OK | Everything worked as expected.  
400 - Bad Request | The request was malformed or rejected by validation.  
401 - Unauthorized | No valid Bearer token provided.  
403 - Forbidden | Token bearer is forbidden from performing the operation.  
404 - Not Found | The requested resource doesn't exist.  
412 - Precondition Failed | A conditional request failed because the resource has been modified since the precondition was specified.  
422 - Unprocessable Entity | The request was syntactically correct but failed due to request semantics, database state, or a business rule.  
5XX - Server Error | Something went wrong on Canvas's end.  
**400**
    ```json
    {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "invalid",
          "details": {
            "text": "The request was malformed or failed validation."
          }
        }
      ]
    }
    ```
**401**
    ```json
    {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "unknown",
          "details": {
            "text": "Authentication failed"
          }
        }
      ]
    }
    ```
**403**
    ```json
    {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "forbidden",
          "details": {
            "text": "Authorization failed"
          }
        }
      ]
    }
    ```
**404**
    ```json
    {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "not-found",
          "details": {
            "text": "Unknown Patient resource 'a47c7b0ebbb442cdbc4adf259d148ea1'"
          }
        }
      ]
    }
    ```
**412**
    ```json
    {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "conflict",
          "details": {
            "text": "The resource has been modified since the precondition was specified."
          }
        }
      ]
    }
    ```
**422**
    ```json
    {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "business-rule",
          "details": {
            "text": "This appointment time is no longer available."
          }
        }
      ]
    }
    ```
**5XX**
    ```json
    {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "exception",
          "details": {
            "text": "Internal server error"
          }
        }
      ]
    }
    ```
----- END PAGE https://docs.canvasmedical.com/api/errors/


----- BEGIN PAGE https://docs.canvasmedical.com/api/goal/
### 
Describes the intended objective(s) for a patient, group or organization  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-goal.html>  
To learn more about how to create goals within the Canvas UI see this [Zendesk article](https://canvas-medical.help.usepylon.com/articles/6744190871-goals-command).
### Endpoints
get /Goal/{id} get /Goal
get
/Goal/{id}
#### Goal read
### Path Parameters
id required
string 
The unique identifier for the Goal   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the goal.
lifecycleStatus 
enum [ proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected ] 
State the goal is in throughout its lifecycle.   
\- Goals that have been closed using a Close Goal Command will have a status of `completed`.   
\- Goal commands that were entered-in-error will have a status of `entered-in-error`.   
\- Goals that are not closed will have the `active` status.   
\- Goals with no lifecycle state set in Canvas will fall back to `accepted`.
achievementStatus 
json 
Describes progress made on goal, from **http://terminology.hl7.org/CodeSystem/goal-achievement**. This corresponds to the `Status` field on the latest committed goal related command.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/goal-achievement 
code 
string 
The code.
**Value Options Supported:**
  - in-progress 
  - improving 
  - worsening 
  - no-change 
  - achieved 
  - sustaining 
  - not-achieved 
  - no-progress 
  - not-attainable 
display 
string 
The display name of the coding.
priority 
json 
Level of importance associated with the reaching/sustaining goal, from **http://terminology.hl7.org/CodeSystem/goal-priority**. This corresponds to the `Priority` field on the latest committed goal related command.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/goal-priority 
code 
string 
The code.
**Value Options Supported:**
  - high-priority 
  - medium-priority 
  - low-priority 
display 
string 
The display name of the coding.
description 
json 
Human readable text of the goal.
Click to view child attributes
text 
string 
Plain text representation of the concept.
subject 
json 
Canvas Patient resource the goal is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
startDate 
date 
When goal pursuit begins.
target 
array[json] 
A single iteration of this field with the **dueDate** , if available. This corresponds to the `Due date` field on the latest committed goal related command.
Click to view child attributes
dueDate 
date 
Reach goal on or before.
expressedBy 
json 
Who created the goal, a **Practitioner** resource. This is the committer of the goal command in the patient's chart.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
note 
array[json] 
Comments about the goal and who wrote them. Notes correspond to any progress/barriers submitted on any of goal related commands.
Click to view child attributes
id 
string 
The Canvas identifier of the goal's note.
authorReference 
json 
Individual responsible for the annotation.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
time 
datetime 
When the annotation was made.
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Goal
#### Goal search
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier for a specific goal.
patient 
string 
Who this goal is intended for in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the goal.
lifecycleStatus 
enum [ proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected ] 
State the goal is in throughout its lifecycle.   
\- Goals that have been closed using a Close Goal Command will have a status of `completed`.   
\- Goal commands that were entered-in-error will have a status of `entered-in-error`.   
\- Goals that are not closed will have the `active` status.   
\- Goals with no lifecycle state set in Canvas will fall back to `accepted`.
achievementStatus 
json 
Describes progress made on goal, from **http://terminology.hl7.org/CodeSystem/goal-achievement**. This corresponds to the `Status` field on the latest committed goal related command.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/goal-achievement 
code 
string 
The code.
**Value Options Supported:**
  - in-progress 
  - improving 
  - worsening 
  - no-change 
  - achieved 
  - sustaining 
  - not-achieved 
  - no-progress 
  - not-attainable 
display 
string 
The display name of the coding.
priority 
json 
Level of importance associated with the reaching/sustaining goal, from **http://terminology.hl7.org/CodeSystem/goal-priority**. This corresponds to the `Priority` field on the latest committed goal related command.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/goal-priority 
code 
string 
The code.
**Value Options Supported:**
  - high-priority 
  - medium-priority 
  - low-priority 
display 
string 
The display name of the coding.
description 
json 
Human readable text of the goal.
Click to view child attributes
text 
string 
Plain text representation of the concept.
subject 
json 
Canvas Patient resource the goal is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
startDate 
date 
When goal pursuit begins.
target 
array[json] 
A single iteration of this field with the **dueDate** , if available. This corresponds to the `Due date` field on the latest committed goal related command.
Click to view child attributes
dueDate 
date 
Reach goal on or before.
expressedBy 
json 
Who created the goal, a **Practitioner** resource. This is the committer of the goal command in the patient's chart.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
note 
array[json] 
Comments about the goal and who wrote them. Notes correspond to any progress/barriers submitted on any of goal related commands.
Click to view child attributes
id 
string 
The Canvas identifier of the goal's note.
authorReference 
json 
Individual responsible for the annotation.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
time 
datetime 
When the annotation was made.
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Goal/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Goal/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Goal",
          "id": "e04a62f8-e6ab-46a1-af34-b635f901e37b",
          "lifecycleStatus": "active",
          "achievementStatus": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
                  "code": "improving",
                  "display": "Improving"
                }
              ]
          },
          "priority": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/goal-priority",
                  "code": "medium-priority",
                  "display": "Medium Priority"
                }
              ]
          },
          "description": {
              "text": "Drink more water"
          },
          "subject": {
              "reference": "Patient/f3d750f5d77d403c96baef6a6055c6e7",
              "type": "Patient"
          },
          "startDate": "2022-01-27",
          "target": [
            {
              "dueDate": "2023-09-28"
            }
          ],
          "expressedBy": {
              "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
              "type": "Practitioner"
          },
          "note": [
            {
              "id": "c2a45d52-b3d7-4e57-bb70-2b82b8819305",
              "authorReference": {
                  "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                  "type": "Practitioner"
              },
              "time": "2023-09-19T20:50:25.955348+00:00",
              "text": "Patient unable to find time to drink during work hours, shows signs of dehydration and fatigue"
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Goal resource 'a47c7b0ebbb442cdbc4adf259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 2,
            "link": [
            {
                "relation": "self",
                "url": "/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7&_count=10&_offset=0"
              },
              {
                "relation": "first",
                "url": "/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7&_count=10&_offset=0"
              },
              {
                "relation": "last",
                "url": "/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7&_count=10&_offset=0"
              }
            ],
            "entry": [
              {
                "resource": {
                    "resourceType": "Goal",
                    "id": "d942b2b6-5c87-4f95-b7d6-51e2355aabf5",
                    "lifecycleStatus": "completed",
                    "achievementStatus": {
                        "coding": [
                          {
                            "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
                            "code": "improving",
                            "display": "Improving"
                          }
                        ]
                    },
                    "priority": {
                        "coding": [
                          {
                            "system": "http://terminology.hl7.org/CodeSystem/goal-priority",
                            "code": "medium-priority",
                            "display": "Medium Priority"
                          }
                        ]
                    },
                    "description": {
                        "text": "Eat one veggie a day"
                    },
                    "subject": {
                        "reference": "Patient/f3d750f5d77d403c96baef6a6055c6e7",
                        "type": "Patient"
                    },
                    "startDate": "2022-12-06",
                    "expressedBy": {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner"
                    },
                    "note": [
                      {
                        "id": "fe2365c7-1a87-43c3-8846-fc26349a8797",
                        "authorReference": {
                            "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                            "type": "Practitioner"
                        },
                        "time": "2022-12-06T17:21:25.172196+00:00",
                        "text": "Not going well only eat skittles"
                      }
                    ]
                }
              },
              {
                "resource": {
                    "resourceType": "Goal",
                    "id": "730e38b4-afaf-476c-914c-5eb0b2de405d",
                    "lifecycleStatus": "active",
                    "achievementStatus": {
                      "coding": [
                        {
                          "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
                          "code": "improving",
                          "display": "Improving"
                        }
                      ]
                    },
                    "description": {
                        "text": "Walk 3 steps each day"
                    },
                    "subject": {
                        "reference": "Patient/f3d750f5d77d403c96baef6a6055c6e7",
                        "type": "Patient"
                    },
                    "startDate": "2023-03-03",
                    "expressedBy": {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner"
                    }
                  }
              }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/goal/


----- BEGIN PAGE https://docs.canvasmedical.com/api/group/
### 
Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.  
<https://hl7.org/fhir/R4/group.html>  
In Canvas Teams and Patient Groups are mapped to the FHIR Group resource.   
See this [Pylon article](https://canvas-medical.help.usepylon.com/articles/5123845479-teams) for information about creating teams in Canvas.  
See this [Pylon article](https://help.canvasmedical.com/articles/8319995182-patient-groups) for information about patient groups in Canvas.
### Endpoints
post /Group get /Group/{id} put /Group/{id} get /Group
post
/Group
#### Group create
Create a Group resource.  
**Note:** The Canvas implementation of Group create/update assigns responsibilities to practitioner Groups using the `characteristic` attribute, rather than using the `characteristic` attribute to establish membership.
### Attributes
resourceType 
string 
The FHIR Resource name.
type 
string required
Identifies the broad classification of the kind of resources the group includes.   
A group with type `person` refers to a Patient Group in canvas, while a group of type `practitioner` refers to a Team in Canvas.
**Value Options Supported:**
  - person 
  - practitioner 
actual 
boolean required
If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.   
While this is a required field in FHIR, Canvas assumes all groups are made up of real individuals, so this will be assumed True for all interactions.
name 
string required
Label for Group.
characteristic 
array[json] 
Identifies traits whose presence or absence is shared by members of the group  
The `text` attribute on the `valueCodeableConcept` for each `characteristic` represents responsibilities held by the Group (in Canvas a Team). Responsibilities may not be shared by more than one team.
If a group of practitioners is created/updated with a responsibility that another group is assigned, the endpoint will return an error dictating the responsibilities have already been assigned.
Click to view child attributes
code 
json required
Kind of characteristic
Click to view child attributes
text 
string required
Plain text representation of the concept.
**Value Options Supported:**
  - responsibility 
valueCodeableConcept 
json required
Value held by characteristic.
Click to view child attributes
text 
string 
Plain text representation of the concept.   
These responsibilities represent the responsibilities of a Canvas Team. They are not applicable for a Patient Group.
**Value Options Supported:**
  - COLLECT_SPECIMENS_FROM_PATIENT 
  - COMMUNICATE_DIAGNOSTIC_RESULTS_TO_PATIENT 
  - COORDINATE_REFERRALS_FOR_PATIENT 
  - PROCESS_REFILL_REQUESTS 
  - PROCESS_CHANGE_REQUESTS 
  - SCHEDULE_LAB_VISITS_FOR_PATIENT 
  - POPULATION_HEALTH_CAMPAIGN_OUTREACH 
  - COLLECT_PATIENT_PAYMENTS 
  - COMPLETE_OPEN_LAB_ORDERS 
  - REVIEW_ERA_POSTING_EXCEPTIONS 
  - REVIEW_COVERAGES 
member 
array[json] 
Who or what is in group.
Click to view child attributes
entity 
json required
Reference to the group member.
Click to view child attributes
reference 
string required
The reference string of the member in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/a09946c97cb04f44bc36f1c08f6d1b76"`.
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Group/{id}
#### Group read
Read a Group resource.
### Path Parameters
id required
string 
The unique identifier for the Group   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Group.
type 
string 
Identifies the broad classification of the kind of resources the group includes.   
A group with type `person` refers to a Patient Group in canvas, while a group of type `practitioner` refers to a Team in Canvas.
**Value Options Supported:**
  - person 
  - practitioner 
actual 
boolean 
If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.   
While this is a required field in FHIR, Canvas assumes all groups are made up of real individuals, so this will be assumed True for all interactions.
name 
string 
Label for Group.
quantity 
integer 
Number of members.
characteristic 
array[json] 
Identifies traits whose presence or absence is shared by members of the group  
The `text` attribute on the `valueCodeableConcept` for each `characteristic` represents responsibilities held by the Group (in Canvas a Team). Responsibilities may not be shared by more than one team.
Click to view child attributes
code 
json 
Kind of characteristic
Click to view child attributes
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - responsibility 
exclude 
boolean 
Group includes or excludes
**Value Options Supported:**
  - false 
valueCodeableConcept 
json 
Value held by characteristic.
Click to view child attributes
text 
string 
Plain text representation of the concept.   
These responsibilities represent the responsibilities of a Canvas Team. They are not applicable for a Patient Group.
**Value Options Supported:**
  - COLLECT_SPECIMENS_FROM_PATIENT 
  - COMMUNICATE_DIAGNOSTIC_RESULTS_TO_PATIENT 
  - COORDINATE_REFERRALS_FOR_PATIENT 
  - PROCESS_REFILL_REQUESTS 
  - PROCESS_CHANGE_REQUESTS 
  - SCHEDULE_LAB_VISITS_FOR_PATIENT 
  - POPULATION_HEALTH_CAMPAIGN_OUTREACH 
  - COLLECT_PATIENT_PAYMENTS 
  - COMPLETE_OPEN_LAB_ORDERS 
  - REVIEW_ERA_POSTING_EXCEPTIONS 
  - REVIEW_COVERAGES 
member 
array[json] 
Who or what is in group.
Click to view child attributes
entity 
json 
Reference to the group member.
Click to view child attributes
reference 
string 
The reference string of the member in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/a09946c97cb04f44bc36f1c08f6d1b76"`.
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
display 
string 
Text alternative for the resource.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Group/{id}
#### Group update
Update a Group resource.  
**Note:** The Canvas implementation of Group create/update assigns responsibilities to practitioner Groups using the `characteristic` attribute, rather than using the `characteristic` attribute to establish membership.
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the Group.
type 
string required
Identifies the broad classification of the kind of resources the group includes.   
A group with type `person` refers to a Patient Group in canvas, while a group of type `practitioner` refers to a Team in Canvas.
**Value Options Supported:**
  - person 
  - practitioner 
actual 
boolean required
If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.   
While this is a required field in FHIR, Canvas assumes all groups are made up of real individuals, so this will be assumed True for all interactions.
name 
string required
Label for Group.
characteristic 
array[json] 
Identifies traits whose presence or absence is shared by members of the group  
The `text` attribute on the `valueCodeableConcept` for each `characteristic` represents responsibilities held by the Group (in Canvas a Team). Responsibilities may not be shared by more than one team.
If a group of practitioners is created/updated with a responsibility that another group is assigned, the endpoint will return an error dictating the responsibilities have already been assigned.
Click to view child attributes
code 
json required
Kind of characteristic
Click to view child attributes
text 
string required
Plain text representation of the concept.
**Value Options Supported:**
  - responsibility 
valueCodeableConcept 
json required
Value held by characteristic.
Click to view child attributes
text 
string 
Plain text representation of the concept.   
These responsibilities represent the responsibilities of a Canvas Team. They are not applicable for a Patient Group.
**Value Options Supported:**
  - COLLECT_SPECIMENS_FROM_PATIENT 
  - COMMUNICATE_DIAGNOSTIC_RESULTS_TO_PATIENT 
  - COORDINATE_REFERRALS_FOR_PATIENT 
  - PROCESS_REFILL_REQUESTS 
  - PROCESS_CHANGE_REQUESTS 
  - SCHEDULE_LAB_VISITS_FOR_PATIENT 
  - POPULATION_HEALTH_CAMPAIGN_OUTREACH 
  - COLLECT_PATIENT_PAYMENTS 
  - COMPLETE_OPEN_LAB_ORDERS 
  - REVIEW_ERA_POSTING_EXCEPTIONS 
  - REVIEW_COVERAGES 
member 
array[json] 
Who or what is in group.
Click to view child attributes
entity 
json required
Reference to the group member.
Click to view child attributes
reference 
string required
The reference string of the member in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/a09946c97cb04f44bc36f1c08f6d1b76"`.
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Group
#### Group search
Search for Group resources.
### Query Parameters
****
_id 
string 
The identifier of the Group.
type 
string 
The type of resources the group contains.
**Search Values Supported:**
  - person
  - practitioner
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Group.
type 
string 
Identifies the broad classification of the kind of resources the group includes.   
A group with type `person` refers to a Patient Group in canvas, while a group of type `practitioner` refers to a Team in Canvas.
**Value Options Supported:**
  - person 
  - practitioner 
actual 
boolean 
If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.   
While this is a required field in FHIR, Canvas assumes all groups are made up of real individuals, so this will be assumed True for all interactions.
name 
string 
Label for Group.
quantity 
integer 
Number of members.
characteristic 
array[json] 
Identifies traits whose presence or absence is shared by members of the group  
The `text` attribute on the `valueCodeableConcept` for each `characteristic` represents responsibilities held by the Group (in Canvas a Team). Responsibilities may not be shared by more than one team.
Click to view child attributes
code 
json 
Kind of characteristic
Click to view child attributes
text 
string 
Plain text representation of the concept.
**Value Options Supported:**
  - responsibility 
exclude 
boolean 
Group includes or excludes
**Value Options Supported:**
  - false 
valueCodeableConcept 
json 
Value held by characteristic.
Click to view child attributes
text 
string 
Plain text representation of the concept.   
These responsibilities represent the responsibilities of a Canvas Team. They are not applicable for a Patient Group.
**Value Options Supported:**
  - COLLECT_SPECIMENS_FROM_PATIENT 
  - COMMUNICATE_DIAGNOSTIC_RESULTS_TO_PATIENT 
  - COORDINATE_REFERRALS_FOR_PATIENT 
  - PROCESS_REFILL_REQUESTS 
  - PROCESS_CHANGE_REQUESTS 
  - SCHEDULE_LAB_VISITS_FOR_PATIENT 
  - POPULATION_HEALTH_CAMPAIGN_OUTREACH 
  - COLLECT_PATIENT_PAYMENTS 
  - COMPLETE_OPEN_LAB_ORDERS 
  - REVIEW_ERA_POSTING_EXCEPTIONS 
  - REVIEW_COVERAGES 
member 
array[json] 
Who or what is in group.
Click to view child attributes
entity 
json 
Reference to the group member.
Click to view child attributes
reference 
string 
The reference string of the member in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"` or `"Practitioner/a09946c97cb04f44bc36f1c08f6d1b76"`.
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner").
display 
string 
Text alternative for the resource.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Group' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Group",
            "type": "practitioner",
            "actual": true,
            "name": "A Test Team",
            "characteristic": [
                {
                    "code": {
                        "text": "responsibility"
                    },
                    "valueCodeableConcept": {
                        "text": "COLLECT_SPECIMENS_FROM_PATIENT"
                    },
                    "exclude": false
                }
            ],
            "member": [
                {
                    "entity": {
                        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39",
                        "type": "Practitioner"
                    }
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Group"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Group",
            "type": "practitioner",
            "actual": True,
            "name": "A Test Team",
            "characteristic": [
                {
                    "code": {
                        "text": "responsibility"
                    },
                    "valueCodeableConcept": {
                        "text": "COLLECT_SPECIMENS_FROM_PATIENT"
                    },
                    "exclude": False
                }
            ],
            "member": [
                {
                    "entity": {
                        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39",
                        "type": "Practitioner"
                    }
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Group/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Group/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Group",
            "id": "3340c331-d446-4700-9c23-7959bd393f26",
            "type": "practitioner",
            "actual": true,
            "name": "A Test Team",
            "quantity": 1,
            "characteristic": [
                {
                    "code": {
                        "text": "responsibility"
                    },
                    "valueCodeableConcept": {
                        "text": "COLLECT_SPECIMENS_FROM_PATIENT"
                    },
                    "exclude": false
                }
            ],
            "member": [
                {
                    "entity": {
                        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39",
                        "type": "Practitioner"
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Group resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Group/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Group",
            "id": "3340c331-d446-4700-9c23-7959bd393f26",
            "type": "practitioner",
            "actual": true,
            "name": "A Test Team",
            "characteristic": [
                {
                    "code": {
                        "text": "responsibility"
                    },
                    "valueCodeableConcept": {
                        "text": "COLLECT_SPECIMENS_FROM_PATIENT"
                    },
                    "exclude": false
                }
            ],
            "member": [
                {
                    "entity": {
                        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39",
                        "type": "Practitioner"
                    }
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Group/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Group",
            "id": "3340c331-d446-4700-9c23-7959bd393f26",
            "type": "practitioner",
            "actual": True,
            "name": "A Test Team",
            "characteristic": [
                {
                    "code": {
                        "text": "responsibility"
                    },
                    "valueCodeableConcept": {
                        "text": "COLLECT_SPECIMENS_FROM_PATIENT"
                    },
                    "exclude": False
                }
            ],
            "member": [
                {
                    "entity": {
                        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39",
                        "type": "Practitioner"
                    }
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Group resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Group?type=practitioner' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Group?type=practitioner"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Group?type=practitioner&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Group?type=practitioner&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Group?type=practitioner&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Group",
                        "id": "3340c331-d446-4700-9c23-7959bd393f26",
                        "type": "practitioner",
                        "actual": true,
                        "name": "A Test Team",
                        "quantity": 1,
                        "characteristic": [
                            {
                                "code": {
                                    "text": "responsibility"
                                },
                                "valueCodeableConcept": {
                                    "text": "COLLECT_SPECIMENS_FROM_PATIENT"
                                },
                                "exclude": false
                            }
                        ],
                        "member": [
                            {
                                "entity": {
                                    "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39",
                                    "type": "Practitioner"
                                }
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/group/


----- BEGIN PAGE https://docs.canvasmedical.com/api/immunization/
### 
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-immunization.html>  
In Canvas, Immunization records are recorded using either the [Immunization Statement Commmand](https://canvas-medical.help.usepylon.com/articles/1379672479-command-immunization-statement) or the [Immunize Command](https://canvas-medical.help.usepylon.com/articles/4155771468-command-immunize).
### Endpoints
post /Immunization get /Immunization/{id} put /Immunization/{id} get /Immunization
post
/Immunization
#### Immunization create
Immunization records created through this endpoint will be stored in an Immunization Statement command on the patient's chart. There currently is no support to create an Immunize command with this endpoint.
### Attributes
resourceType 
string 
The FHIR Resource name.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note. If neither is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string required
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
enum [ completed | entered-in-error | not-done ] required
The status of the immunization.
**Value Options Supported:**
  - completed 
vaccineCode 
json required
Coding for the administered vaccine.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/cvx 
  - http://www.ama-assn.org/go/cpt 
code 
string required
The code.
display 
string 
The display name of the coding.
patient 
json required
The patient who received the immunization.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Supply an encounter reference to be able to insert the command into a specific note on the patient's timeline. If no encounter is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.   
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string required
The reference string of the encounter in the format of `"Encounter/76028e14e77a47f4b95149bf5b7400bb"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
occurrenceDateTime 
datetime required
The date or datetime the immunization was administered or reported to have been administered.
primarySource 
boolean required
Whether the immunization was administered by a primary source.
On create accepts only **false**.
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `comment` field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Immunization/{id}
#### Immunization read
### Path Parameters
id required
string 
The unique identifier for the Immunization   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the immunization.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
enum [ completed | entered-in-error | not-done ] 
The status of the immunization.
**Value Options Supported:**
  - completed 
  - entered-in-error 
  - not-done 
statusReason 
json 
A coding for reason not given, if recorded - omitted otherwise.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-ActReason 
code 
string 
The code.
display 
string 
The display name of the coding.
vaccineCode 
json 
Coding for the administered vaccine.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/cvx 
  - http://www.ama-assn.org/go/cpt 
code 
string 
The code.
display 
string 
The display name of the coding.
patient 
json 
The patient who received the immunization.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
The encounter related to the provided Note in the extension of this resource.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/76028e14e77a47f4b95149bf5b7400bb"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
occurrenceDateTime 
datetime 
The date or datetime the immunization was administered or reported to have been administered.
primarySource 
boolean 
Whether the immunization was administered by a primary source.
  - **true** indicates that the immunization was administered within the clinic. To document immunizations like these, use an [Immunize Command](https://canvas-medical.help.usepylon.com/articles/4155771468-command-immunize).  
\- **false** indicates that the immunization was administered outside the clinic. To document this immunizations like these, use an [Immunization Statement Command](https://canvas-medical.help.usepylon.com/articles/1379672479-command-immunization-statement).
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `comment` field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Immunization/{id}
#### Immunization update
Update an Immunization resource.  
The only type of Immunization update interaction that is supported by Canvas is to mark an existing Immunization Statement as **entered-in-error** using the `status` attribute. No changes to other fields will be processed; however, required fields still need to be supplied.
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The Canvas identifier of the immunization.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string required
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
enum [ completed | entered-in-error | not-done ] required
The status of the immunization.
**Value Options Supported:**
  - entered-in-error 
vaccineCode 
json required
Coding for the administered vaccine.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/cvx 
  - http://www.ama-assn.org/go/cpt 
code 
string required
The code.
display 
string 
The display name of the coding.
patient 
json required
The patient who received the immunization.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
The encounter related to the provided Note in the extension of this resource.
Click to view child attributes
reference 
string required
The reference string of the encounter in the format of `"Encounter/76028e14e77a47f4b95149bf5b7400bb"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
occurrenceDateTime 
datetime required
The date or datetime the immunization was administered or reported to have been administered.
primarySource 
boolean required
Whether the immunization was administered by a primary source.
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `comment` field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Immunization
#### Immunization search
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier for a specific immunization.
patient 
string 
The patient for the vaccination record in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the immunization.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
enum [ completed | entered-in-error | not-done ] 
The status of the immunization.
**Value Options Supported:**
  - completed 
  - entered-in-error 
  - not-done 
statusReason 
json 
A coding for reason not given, if recorded - omitted otherwise.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-ActReason 
code 
string 
The code.
display 
string 
The display name of the coding.
vaccineCode 
json 
Coding for the administered vaccine.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/cvx 
  - http://www.ama-assn.org/go/cpt 
code 
string 
The code.
display 
string 
The display name of the coding.
patient 
json 
The patient who received the immunization.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
The encounter related to the provided Note in the extension of this resource.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/76028e14e77a47f4b95149bf5b7400bb"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
occurrenceDateTime 
datetime 
The date or datetime the immunization was administered or reported to have been administered.
primarySource 
boolean 
Whether the immunization was administered by a primary source.
  - **true** indicates that the immunization was administered within the clinic. To document immunizations like these, use an [Immunize Command](https://canvas-medical.help.usepylon.com/articles/4155771468-command-immunize).  
\- **false** indicates that the immunization was administered outside the clinic. To document this immunizations like these, use an [Immunization Statement Command](https://canvas-medical.help.usepylon.com/articles/1379672479-command-immunization-statement).
note 
array[json] 
Additional text not captured in other fields.   
Canvas will display this in the `comment` field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Immunization' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
          {
            "resourceType": "Immunization",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f"
                }
            ],
            "status": "completed",
            "vaccineCode": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/sid/cvx",
                        "code": "110"
                    },
                    {
                        "system": "http://www.ama-assn.org/go/cpt",
                        "code": "90723"
                    }
                ]
            },
            "patient": {
                "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb"
            },
            "occurrenceDateTime": "2024-10-04",
            "primarySource": false,
            "note": [
              {
                "text": "First Dose"
              }
            ]
          }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Immunization"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json",
        }
        payload = {
            "resourceType": "Immunization",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f"
                }
            ],
            "status": "completed",
            "vaccineCode": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/sid/cvx",
                        "code": "110"
                    },
                    {
                        "system": "http://www.ama-assn.org/go/cpt",
                        "code": "90723"
                    }
                ]
            },
            "patient": {
                "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb"
            },
            "occurrenceDateTime": "2024-10-04",
            "primarySource": False,
            "note": [
              {
                "text": "First Dose"
              }
            ]
        }
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Immunization/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Immunization/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Immunization",
          "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
          "extension": [
            {
                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f"
            }
          ],
          "status": "completed",
          "vaccineCode": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/sid/cpt",
                  "code": "91306",
                  "display": "Severe acute respiratory syndrome coronavirus 2 (SARS-CoV-2) (coronavirus disease [COVID-19]) vaccine, mRNA-LNP, spike protein, preservative free, 50 mcg/0.25 mL dosage, for intramuscular use"
                },
                {
                  "system": "http://hl7.org/fhir/sid/cvx",
                  "code": "207",
                  "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose"
                }
              ]
          },
          "patient": {
              "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
              "type": "Patient"
          },
          "encounter": {
            "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb"
          },
          "occurrenceDateTime": "2022-05-26T18:55:34.629659+00:00",
          "primarySource": false,
          "note": [
            {
              "text": "First Dose"
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Immunization resource 'd9aefede-da05-4bef-bbf9-63bcf83c806b'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Immunization/d9aefede-da05-4bef-bbf9-63bcf83c806a' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
          {
            "resourceType": "Immunization",
            "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f"
                }
            ],
            "status": "entered-in-error",
            "vaccineCode": {
                "coding": [
                    {
                      "system": "http://hl7.org/fhir/sid/cpt",
                      "code": "91306",
                      "display": "Severe acute respiratory syndrome coronavirus 2 (SARS-CoV-2) (coronavirus disease [COVID-19]) vaccine, mRNA-LNP, spike protein, preservative free, 50 mcg/0.25 mL dosage, for intramuscular use"
                    },
                    {
                      "system": "http://hl7.org/fhir/sid/cvx",
                      "code": "207",
                      "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose"
                    }
                ]
            },
            "patient": {
                "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb"
            },
            "occurrenceDateTime": "2024-10-04",
            "primarySource": False,
            "note": [
              {
                "text": "First Dose"
              }
            ]
          }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Immunization/d9aefede-da05-4bef-bbf9-63bcf83c806a"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json",
        }
        payload = {
            "resourceType": "Immunization",
            "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f"
                }
            ],
            "status": "entered-in-error",
            "vaccineCode": {
                "coding": [
                    {
                      "system": "http://hl7.org/fhir/sid/cpt",
                      "code": "91306",
                      "display": "Severe acute respiratory syndrome coronavirus 2 (SARS-CoV-2) (coronavirus disease [COVID-19]) vaccine, mRNA-LNP, spike protein, preservative free, 50 mcg/0.25 mL dosage, for intramuscular use"
                    },
                    {
                      "system": "http://hl7.org/fhir/sid/cvx",
                      "code": "207",
                      "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose"
                    }
                ]
            },
            "patient": {
                "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb"
            },
            "occurrenceDateTime": "2024-10-04",
            "primarySource": False,
            "note": [
              {
                "text": "First Dose"
              }
            ]
        }
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Immunization resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Immunization?patient=Patient/4d9c4a797b8c4a58872017e7a19a474e' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Immunization?patient=Patient/4d9c4a797b8c4a58872017e7a19a474e"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
              {
                "relation": "self",
                "url": "/Immunization?patient=Patient%2F4d9c4a797b8c4a58872017e7a19a474e&_count=10&_offset=0"
              },
              {
                "relation": "first",
                "url": "/Immunization?patient=Patient%2F4d9c4a797b8c4a58872017e7a19a474e&_count=10&_offset=0"
              },
              {
                "relation": "last",
                "url": "/Immunization?patient=Patient%2F4d9c4a797b8c4a58872017e7a19a474e&_count=10&_offset=0"
              }
            ],
            "entry": [
              {
                "resource": {
                  "resourceType": "Immunization",
                  "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
                  "extension": [
                    {
                      "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                      "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f"
                    }
                  ],
                  "status": "completed",
                  "vaccineCode": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/sid/cpt",
                        "code": "91306",
                        "display": "Severe acute respiratory syndrome coronavirus 2 (SARS-CoV-2) (coronavirus disease [COVID-19]) vaccine, mRNA-LNP, spike protein, preservative free, 50 mcg/0.25 mL dosage, for intramuscular use"
                      },
                      {
                        "system": "http://hl7.org/fhir/sid/cvx",
                        "code": "207",
                        "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose"
                      }
                    ]
                  },
                  "patient": {
                      "reference": "Patient/4d9c4a797b8c4a58872017e7a19a474e",
                      "type": "Patient"
                  },
                  "encounter": {
                    "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb"
                  },
                  "occurrenceDateTime": "2021-12-01",
                  "primarySource": false
                }
              },
              {
                "resource": {
                  "resourceType": "Immunization",
                  "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
                  "extension": [
                    {
                      "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                      "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f"
                    }
                  ],
                  "status": "completed",
                  "vaccineCode": {
                    "coding": [
                      {
                          "system": "http://www.ama-assn.org/go/cpt",
                          "code": "90715",
                          "display": "TDAP VACCINE 7 YRS/> IM"
                      },
                      {
                          "system": "http://hl7.org/fhir/sid/cvx",
                          "code": "115",
                          "display": "Tdap"
                      }
                    ]
                  },
                  "patient": {
                      "reference": "Patient/4d9c4a797b8c4a58872017e7a19a474e",
                      "type": "Patient"
                  },
                  "encounter": {
                    "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb"
                  },
                  "occurrenceDateTime": "2021-12-01",
                  "primarySource": false,
                  "note": [
                    {
                      "text": "First Dose"
                    }
                  ]
                }
              }
            ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/immunization/


----- BEGIN PAGE https://docs.canvasmedical.com/api/letter/
This API allows customers to create letters. The effect of creating a letter is the same as creating a letter in the user interface. Content can be added using HTML & CSS. Placeholders created in Canvas will not be respected.
##  Authentication 
The Letter API uses the existing Canvas OAuth authentication flow, so you can simply post to the existing auth token endpoint /auth/token/
This endpoint was built as an addition to the Note API and uses the user/Note.write scope. This scope will not be in OAuth applications that were created prior to the release of the Note API. To get access:
  - Create a new [OAuth application](/api/customer-authentication)
  - Ask Canvas to add the new scopes to an existing OAuth application
![description](/assets/images/allowed-scopes.png)
    ```python
    import requests
    url = "https://<your-instance>.canvasmedical.com/auth/token/"
    payload = 'grant_type=client_credentials&client_id=canvas&client_secret=canvas'
    headers = {
      'Content-Type': 'application/x-www-form-urlencoded'
    }
    response = requests.request("POST", url, headers=headers, data=payload)
    print(response.text)
    ```
Then use your token in the request headers as you do with the FHIR API:
![description](/assets/images/note-api-token.png)
##  Create 
To create a Note resource, POST to `https://<your-instance>.canvasmedical.com/core/api/letter/v1/Letter` using the supported attributes below. Letters will be staged on the patient's chart to then be faxed or printed. Further edits can be made in the UI as needed.
###  Attributes 
**`patientKey` (req)** text  
The unique key of the Patient for which this letter is written.
* * *
**`providerKey` (req)** text  
The unique key of the Provider staff who is responsible for the letter.
* * *
**`practiceLocationKey` (req)** text  
The unique key of the PracticeLocation for which this letter is written.
* * *
**`content`**  
The contents of the letter. Supports HTML & CSS. **Placeholders created in Canvas will NOT be respected.**
###  Example 
    ```python
    import requests
    import json
    url = "https://<your-instance>.canvasmedical.com/core/api/letter/v1/Letter"
    payload = json.dumps({
      "patientKey": "8d84776879de49518a4bc3bb81d96dd4",
      "providerKey": "5eede137ecfe4124b8b773040e33be14",
      "practiceLocationKey": "c67e0c59-d4d2-428c-bc13-b6e85d181ad0",
      "content": "<p>To Whom It May Concern,</p><p>Letty Letters is a patient of mine at PRACTICE NAME. Due to a current medical condition, the patient is unable to fulfill the requirements for jury duty.</p><p>Thanks,</p></div><div class=\"signature\"><img src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/b/be/Zhu_Zhengting_signature.jpg/1280px-Zhu_Zhengting_signature.jpg\" alt=\"Signature\" width=\"200\"></div></div></html>"
    })
    headers = {
      'Authorization': 'Bearer HqFtbSnBNX4S65VhRrg8sRxO6XcSFp',
      'Content-Type': 'application/json'
    }
    response = requests.request("POST", url, headers=headers, data=payload)
    print(response.text)
    ```
----- END PAGE https://docs.canvasmedical.com/api/letter/


----- BEGIN PAGE https://docs.canvasmedical.com/api/location/
### 
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-location.html>  
The FHIR Location resource corresponds to Canvas Practice Locations.
### Endpoints
get /Location/{id} get /Location
get
/Location/{id}
#### Location read
Read a Location resource.
### Path Parameters
id required
string 
The unique identifier for the Location   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Location
identifier 
array[json] 
Unique code or number identifying the location to its users. Currently this supports displaying the Group NPI.
Click to view child attributes
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/us-npi 
value 
string 
The value that is unique.
status 
enum [ active | inactive ] 
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
name 
string 
Name of the location as used by humans. This is the practice location's full name in Canvas.
alias 
array[string] 
A list of alternate names that the location is known as, or was known as, in the past. This is the practice location's short name in Canvas.
description 
string 
Additional details about the location that could be displayed as further information to identify the location beyond its name. Canvas will produce this in the format `Organization full name: Location full name`
address 
json 
Physical location.
Click to view child attributes
use 
enum [ home | work | temp | old | billing ] 
Purpose of this address
type 
enum [ both | physical | postal ] 
Distinguishes between physical and postal addresses.
line 
array[string] 
Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label.
city 
string 
Name of city, town etc.
state 
string 
Sub-unit of country (Canvas uses abbreviations).
postalCode 
string 
Postal code for area.
country 
string 
Country
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Location
#### Location search
Search for Location resources.
### Query Parameters
****
_id 
string 
The identifier of the Location.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Location
identifier 
array[json] 
Unique code or number identifying the location to its users. Currently this supports displaying the Group NPI.
Click to view child attributes
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/us-npi 
value 
string 
The value that is unique.
status 
enum [ active | inactive ] 
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
name 
string 
Name of the location as used by humans. This is the practice location's full name in Canvas.
alias 
array[string] 
A list of alternate names that the location is known as, or was known as, in the past. This is the practice location's short name in Canvas.
description 
string 
Additional details about the location that could be displayed as further information to identify the location beyond its name. Canvas will produce this in the format `Organization full name: Location full name`
address 
json 
Physical location.
Click to view child attributes
use 
enum [ home | work | temp | old | billing ] 
Purpose of this address
type 
enum [ both | physical | postal ] 
Distinguishes between physical and postal addresses.
line 
array[string] 
Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label.
city 
string 
Name of city, town etc.
state 
string 
Sub-unit of country (Canvas uses abbreviations).
postalCode 
string 
Postal code for area.
country 
string 
Country
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Location/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Location/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Location",
            "id": "a04b44ec-c7df-4808-9043-e9c4b1d352a9",
            "identifier": [
                {
                    "system": "http://hl7.org/fhir/sid/us-npi",
                    "value": "12321"
                }
            ],
            "status": "active",
            "name": "Canvas Medical",
            "alias": [
                "Canvas Medical HQ"
            ],
            "description": "Canvas Medical, San Francisco, CA",
            "address": {
                "use": "work",
                "line": [
                    "405 49th St"
                ],
                "city": "Oakland",
                "state": "CA",
                "postalCode": "94609",
                "country": "USA"
            }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Location resource 'a04b44ec-c7df-4808-9043-e9c4b1d352a9'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Location' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Location"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Location?_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Location?_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Location?_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Location",
                        "id": "a04b44ec-c7df-4808-9043-e9c4b1d352a9",
                        "identifier": [
                            {
                                "system": "http://hl7.org/fhir/sid/us-npi",
                                "value": "12321"
                            }
                        ],
                        "status": "active",
                        "name": "Canvas Medical",
                        "alias": [
                            "Canvas Medical HQ"
                        ],
                        "description": "Canvas Medical, San Francisco, CA",
                        "address": {
                            "use": "work",
                            "line": [
                                "405 49th St"
                            ],
                            "city": "Oakland",
                            "state": "CA",
                            "postalCode": "94609",
                            "country": "USA"
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/location/


----- BEGIN PAGE https://docs.canvasmedical.com/api/media/
### 
A photo, video, or audio recording acquired or used in healthcare.  
<https://hl7.org/fhir/R4/media.html>  
FHIR Media maps to a [Visual Exam Finding Command](https://canvas-medical.help.usepylon.com/articles/4119751144-command-visual-exam-finding) in Canvas.
### Endpoints
post /Media get /Media/{id} get /Media
post
/Media
#### Media create
Create a Media resource.
### Attributes
resourceType 
string 
The FHIR Resource name.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note. If neither is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Click to view child attributes
url 
string 
Source that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
string required
The current state of the media.
**Value Options Supported:**
  - completed 
  - entered-in-error 
subject 
json required
Who/What this Media is a record of.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter associated with media.
Supply an encounter reference to be able to insert the Visual Exam Finding command into a specific note on the patient's timeline. If no encounter is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.   
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/086cd6fe-2c94-455d-a53e-6ff1c2652cae"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
operator 
json 
The person who generated the image.  
The operator attribute contains a reference to the practitioner or patient that generated the media. This will show up in the Canvas UI as the value for Originator when you click the command in the tooltip that pops up. If omitted, it will default to Canvas Bot.
Click to view child attributes
reference 
string 
The reference string of the operator in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
content 
json required
Actual Media.
Click to view child attributes
contentType 
string required
Mime type of the content, with charset etc.
**Value Options Supported:**
  - image/heic 
  - image/jpeg 
  - image/png 
data 
string required
Inline data in Base64 format.
title 
string 
Label to display in place of the data. This will appear on the Visual Exam Finding Command in the patient's chart.
note 
array[json] 
Comments made about the media  
The note attribute is an array of JSON objects, each of which contains a text attribute that contains the text of a comment that will be attached to the inserted media on the UI.
Click to view child attributes
text 
string required
The annotation - text content.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Media/{id}
#### Media read
Read a Media resource.
### Path Parameters
id required
string 
The unique identifier for the Media   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Media.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Source that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
string 
The current state of the media.
**Value Options Supported:**
  - completed 
  - entered-in-error 
subject 
json 
Who/What this Media is a record of.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter associated with media.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/086cd6fe-2c94-455d-a53e-6ff1c2652cae"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
operator 
json 
The person who generated the image.  
The operator attribute contains a reference to the practitioner or patient that generated the media. This will show up in the Canvas UI as the value for Originator when you click the command in the tooltip that pops up. If omitted, it will default to Canvas Bot.
Click to view child attributes
reference 
string 
The reference string of the operator in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
content 
json 
Actual Media.
Click to view child attributes
contentType 
string 
Mime type of the content, with charset etc.
**Value Options Supported:**
  - image/heic 
  - image/jpeg 
  - image/png 
title 
string 
Label to display in place of the data. This will appear on the Visual Exam Finding Command in the patient's chart.
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
note 
array[json] 
Comments made about the media  
The note attribute is an array of JSON objects, each of which contains a text attribute that contains the text of a comment that will be attached to the inserted media on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Media
#### Media search
Search for Media resources.
### Query Parameters
****
_id 
string 
The identifier of the Media.
patient 
The patient the media is associated with in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Media.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Source that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
string 
The current state of the media.
**Value Options Supported:**
  - completed 
  - entered-in-error 
subject 
json 
Who/What this Media is a record of.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter associated with media.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/086cd6fe-2c94-455d-a53e-6ff1c2652cae"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
operator 
json 
The person who generated the image.  
The operator attribute contains a reference to the practitioner or patient that generated the media. This will show up in the Canvas UI as the value for Originator when you click the command in the tooltip that pops up. If omitted, it will default to Canvas Bot.
Click to view child attributes
reference 
string 
The reference string of the operator in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
content 
json 
Actual Media.
Click to view child attributes
contentType 
string 
Mime type of the content, with charset etc.
**Value Options Supported:**
  - image/heic 
  - image/jpeg 
  - image/png 
title 
string 
Label to display in place of the data. This will appear on the Visual Exam Finding Command in the patient's chart.
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
note 
array[json] 
Comments made about the media  
The note attribute is an array of JSON objects, each of which contains a text attribute that contains the text of a comment that will be attached to the inserted media on the UI.
Click to view child attributes
text 
string 
The annotation - text content.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Media' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Media",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "status": "completed",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "operator": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "content": {
                "contentType": "image/jpeg",
                "data": "/9j/4AAQSkZJRgABAQAASABIAAD/4QCMRXhpZgAATU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAOSgAwAEAAAAAQAAAUAAAAAA/+0AOFBob3Rvc2hvcCAzLjAAOEJJTQQEAAAAAAAAOEJJTQQlAAAAAAAQ1B2M2Y8AsgTpgAmY7PhCfv/AABEIAUAA5AMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/3QAEAA//2gAMAwEAAhEDEQA/APPNzscLnHsKFRs9/wATWisaY5yackKA8ITXiOqex7NFVYcjPFQzW5JGAx+nFbSxHGAn6U2W03kFhyPepdQ0hFJlC1tpWUAL0PUmtG08yzdWbb16ipba0G3AVifTFX4tOdx9zg+vFJVbM0kk1YqahqN7FbNLp5UOeWRlzn3Fc23iTV5/kWaQknpGnP6V3FrpWzLTsGA6AVdT7LEMbo0I6YAr0KeYcqs1c8urgVKV0ebGPXLw8RXsmfXIH61PH4Y1efG9I4x6ySc/pXoL3cC8Lvc+wqlPOzuTGHAPYkYqZZjN7IuGXw6nKJ4Ol2j7RfRrjsiZx+dWI/CemRjM89xN/wAC2j9K2J3mYAAIR7VGltNL/wAtNoFYSxlV9TpjgqS6FSLR9IgGY7NH7bnJb+dWR9ktuI0gjH+yBSvZIoJkm/WoWSzQDncawlVlLds3jQhHZDZb9c4jOR7LUD3Dt0Rz9TintcQp9xM0gu8rnaq1FzRRK7ySsMEKF9CM1X+zknOW/AVYlu2I+/j6Cqz3APVmP44pXZaih4tyB93n/aNIYDkZdR6Ypolb+Afj1pv71sEcUXHZFiO23MoLMad9lxIdoNVP3qydTVxZbg9FJ/2jSbYiX7MwwM4pTaAjDSnGOmTTMTEjcyj8aeIst802PwqOZgOFnCACSv8AOmy28Y5ErfQCp0SBRksSfrSSTwp91Rn3p8zGVHQ9FaT1zxU0UjL2pxuTjCpgfTFRE7j2H0rObuVEV5W3df0pPNf+9+lMKUbKgo//0MX7Ds+8yCnrHbRnEk4/Cs6QlpMZJ78mkUEc4FfOM95Rua6PZA8b5CPale7jUfuoAP8AeNUITnrtz25xVjygV+bbUtjUUieG+mJ+VY1z7VL58rDDzkH0FU4UijkBLgmr6xllyoIGMdMU4o0dkVlOSdwdvc0rSBRwUWoTCqyku4PsOTTmijxnyZHx+AqrhZEUkhYn9630WljdiRtDMRTlkAGEiSMfTNL5rMvDOf8AdGKeo7oXM6jKgLxVWRrhjh5kH0Of5VKUlb7sOf8Ae/8Ar0eVdEdEUf72KEguRBBjpI/vgAVRl2iTb8oY9s9K0RbMpy03XsBnFDWanH3mJ6Gmog5WMO6uI7dczSBFOQT6UWl1a3dtmCUv/ujimeL4YorGNTHvMjAbcdB6k1wd5cyWeoMlm7QMuSAuSpP06H6V6FLBqcL9TzquNcJ2Wx6CYyQdsR/4EaTymyMFF/CuGs/Eup3jMsbIHVCzBhjOOuP8O1WbfxXG0qJcwuAwGW39PY/jxWE8FUjsdEMbSlvodoDGv3paaJ4gflVmx0xWbaXtvcRq0XAJxyOass+xckcZxzXLOnKOjR1RnCXwssvcnIIAHtmk8+Q9z+VVopfMOEIz9amELtyZMfQVlYq6FaRj952x9adFKmfvZphjiXmRh9Gap7cQqQQV/AUJBcn8xQPmwPrQpDDKkY9aWS5hA+Zl/OqkmowL90Z7cVoqcpbIzlVit2WwqEkGQMfQc1Iir/dJPuaxX1QDd5car9ag/tGZ/wCPA9qv6nOW5k8ZTj5nQHrwFFHP+x+Vc+biQ8+a350nnyf89G/OtPqL7mf1+PY//9HlJnJUbWI/3RURt1kOTvJ/3uKvQ2pEY3MCe9FtEhTdgsD3r5xytsfQWILWzVeQOa04rfcBjOPc0qlEHRfxqwlxwMEY9hWcpMdhkdpsPAx/u1owxYHIH4mqJnIJIDEe/akF0emD+FKMmVYusiJycfgKQug9aqGRmJ/SjcqQvNM4SJRngda1p03N2QpSUFdhIYIQzmNQByT1ri9Z8RNJeMlvI8cK8AIME+/HatNGufEmoLbWTyRW5OAEGWb1JPYV1T+GLHT7GNWG+U9AfmYn+lexRw6oq8tWeVVrus7R0R5/D4jvbZMzCR0Bxh1z+tdz4Md9alQqiyFtpCr1Kk85HpiuVvdNk1W4FvaqRGzFRKoyAR0r2j4X6CmjWUUsiBWJLFV6IT1I7gZ7V0LD05Lma1MHiakHa5h3vhs2l4d6sIpMqCR93Jxir2saJHbWcTIgbY21jjn6/Su51t0kbAUFZB17Zqstl9stZYyMsE7j9fyNOOHgtkKWKm9zwfx3p7SWmWBhWOQAkj+E8V5drtnJHIPKQqNoKn0OcbjX1Vq3hZboSs0YeQZHz96xZfhbDfRSz31wY4gqxxRqo5Pp7iuiEUlY55Tu7ny9dW8trL5sIYGeMhscYVu3t0qSxsZUulnaLCYyDL8q57/UV9Px/CTTIg0rrJPMBkbuQretcN4s8NGCxmN3HEjQuRlPvBT6+9E1bYujabszyz+x7t4hIlwVycDylKj/AOvWrpdzJa3sdlqEoeVovMQsPmA9T/StjQIpHuYbY8I6l4/6Vj+IdJnj1gXRDFwe469v/wBVcdWKmmmdqbotSRpTXEEZGw5b/eqL7cx48w/QCsyWPY3UZ68dqZvC98AetcKw0VubyxU3sXbi5AO4qC3qeaYLuQ/ecnNZ012i8buaqNfkMFTDNnHFbxpJbI551ZS3ZveaT35PrR5gIw3Ws2KYsoLsxx1xWjBcwfL5iD3J6VooGLkAkQDkin716dM9Peo5Lq35XyV9ivcVOJ7Ty8pbtj34quUTY3ap6sRRsX+/R5lo3LBs/U0b7P0f8zRysLn/0sKMsynH8qaqso2gYA9amt42B+9j6VM0A98+ua+VbPpSsIWYfM549BVlUCqDjjvzT4o1JCkkn3NWUQBcbanmFYpvIoPysMntUJmVS3OT6YqZrMByzOFX0pPLhi5DCqGkNhMkoxtIOME+1Yfii4M95FYRvjbgsM9fyrovtAjhZxgBQTXn+mPJqV1d3G4jzN370DkduPyFe1l8LJzkjzMfO9oRNfw3qGqQassWlpEtgi7Wdl+99K39avpZpILM3WLlwS+xM7V/Cuf0vU7jRLIwSwRSopysoOMfX3q9osz6vqnmW5C3DEYypbA/CvRT5nc4U1CNup3/AMPdCe3XfLOs0AJbITBJPbmvQIJWkcpGdq44DcflVLRbBbLTI4C5kbGWZu5q20UYH7tMtn7v+FXcwk7l6wCtO1vcjcHHDD17VppbPZeSyLlBlH/pWRb/AL7A5WQnjP8AjXQ2D+Y4hZy3mIeo9KpEspXn7woFAUsxJPtVqF1uBwmYkYRrn+I1CkAkZI2ztVOfUZOK2IbRAqbWCpH8qj09T9aptIncYbcDhVLnuRiuS8X+G49YsJomgJZhyGI5ruLWBEYiJwFPPPc1b+zow5A9+KlyHG6dz5T8QeH4tBFm5DGZpMAddqjpn2pNUi06WGZ7hYw4Qk8V6p8U9FntZDPDA0trICSAuSp+uK8K1C6kMro8ZWIDO1uGb3x1rCpHqdiq8yszjLlx5rMpO0ms66uAoIyK37y1inBMQCHPJUcY9cVy2owPHJ91jGej9jXPYq5CXDBjuA+nNLb481RgnPQ1HswBnnPUUAbeR909qpC3NtBtK7l254JzQSCxxhVIyBVSC4dxnO7PUEc1O8sYUkj5h1B4IpkkgUnozY9M96VX2swb8M9v/rVCkzBiAA3cNUnmbuRjdnkUCJ2PJ2ybfYUm4/8APU/lVSR9xBI3nHXFMyP+ef6U7isf/9PK81Iyd0g/Ckkvrfb1yfzrDKqRjqT0zTtu1duMHrXhrA92exLGR6I1W1LbxFExB6E8U1tQlHDDbmszcQMAs3qMUvm/Ke56etbxwdNGUsXN7E5vncsFIGDjPWoPMaRiGJY549qYWLAngDuMU6JVDA43Aen6VvGlCOyMpVpy3Za1OHytGlg80iSYbSR2z2rIt0SGIRxngdeOtX7mWadl81AFXgBT7daoOMMO3PBFbOXRGVurHqdwZZF3IeMEV23wlt4IpbmCdw7k713LwBXDrIBwc8cV6D8K4EudSlZ22hV4NXTk9iJxVrnpV1PDDACM/U8D8K5ifW7mM77lUs7Z2+WadwqsPxOa3/EELiyne1VJJIkLokh4bA6V8q65dS6xefb9Tlnu55GLYZgCn/TNc5CL06Dp6mumCOZn0lB4kt5ruBBKqyA4Zd+5TjowNd34avxc6n8pDqqszEdu1fI1vfw2en2V7ZxXFvas5hkWWUOPMVdzsrf3McduR0619HeC7tNP8O3N3dNsMjAAtx8g55+tXy2Ym9D0B5FTU1yv7tgQx9OeKyZNYlgtpnY5UMRyf881Wk1RZb+KVmPkyEZI7GuT+Jl0umWt7MGdYAPPOznngnHvx096JRuKDsdSdcjYOsF0GnXB4PGfQetdb4b1Ke5iCXagSjr718i65G411UvX1CR3UStFalBtLD92oLHBBGcnjBFev/AHVb+W5vNOnnlmi8tZ44ZH3+RyQVVjyQcEjJ47cUpRshrVntmtRwPplwbtgkKoWZycBQO9fIHi+a0utXup7BRFbyOcdSWA6MT7/pX1X46VpPB+pqkwiPkt85OK+P8AVG/fOVbcuMsBwR/Q1zzeljaC1uZzLuc4wrMSeOlUrmAyRY4OOqd/xFWXYrCrHYeMg+uPaqbTksCoLHbjbnkEdxXO2a2MLUdPZWBtgXBySueRWZgqMHdkdcjBrqd6vkr8r5wxxwfr70y9t1uvvgK4GC2OeKdwRzkMjRkFSVPQ1ceSKRAwKt7d80y8sJ7bDMNydcj0qtbNHFKMgYJ7800waLSMM5UN6+mKkYFyWHDE9KZLcKvbrxkVXeZlJIG7+dUTYlJyxyxB9M4o4/vn/vqoo7lWGQ3/AI6DTvPH97/xwUwP/9TjdxEnC4wepqYSA8sxByMDGc+tR+WzksB09T3pgUqcuxB7c1zG5MJdnXkk4ORUMj4bKjOetPcgEeU3JGTmojIxcgjkjOcUDQ1yMl1Yqw4IByKUPgcAk9M0z5cjHGe/oalChQckkfWkUkR+YwJ9DTZj0AOD6GnYGSQeDzzTRG80qrGmSxAUL1zQtRjEBOG28cc16H8MpoRf+WJQsmCSrLwfoaydI8LCRS1xMNy8BAOD+NdfpVvb2Bh+zxqEY8kDOR/OtYqxnN3Ru+K5Xt7N9v3ACcpwenvXht7pmmam7efHJHdE/MyNtDnqSBXu2sQ/aLBgSWymBXA6b4WWHMly4DAnaAOnPAFbxkkjFK5xGm6Q13e28V3aGKziyVLSliF6kFTxg121zfTDTbe0jkAjUD92WBAXt/Wpbu1WGGRp2CS7sfuxndWPawHyZfJTEof5zIcEk8gj61akJxOv0jVZJ7dYWYBVTHoRyAcGtDXtIbVNPaHe0iqu9VY8M2OCe/0rk/DojS8EYbap5bb1HPTFeh6CVkcRiQPuHVh0puRPLqeX/wBg3OtXIg1UCAxxkR5TOUz0BNejeAdKt9FvrVNPfzZW/wBdKrZz2x/TtitbW9HnjQpbRZByw4HX29D+hqH4eWlxa6xP9qU54Ctsxj60nK6G1ZnovieOCXw/cC7iWWIJkoVJz+Ar441yJ49UuAFaMiU4GMYGf8K+t/iFqB0zwjeXETL5gAClzgAnivkXViZbmRnbexzuJ6+//wCquaexrBGNMrqoDI2GJClewHof6VSdQoySAT0IFaLvtiwTlf8APSqcw3yHbux78fiPesGaFbZgZkyOM5HXP+FTkB1UHI9Dnr71Lt3YCqSBglum3j9RUZ+TIPBxlfQeuaAEyQ7Zwyk4Oe/0rN1LSVZmaHapPIwML+PvWnDIrRyqvEqjGD+n+elRTyloyGwpPcd//r0xHMOZYn8iVcH1b/PIqKQYfA4Y8+1bV9Esw+YZboCO3vWPdQeXnHKNx16VadwZXC7hnbz3yKXy/wDZH5UZCgAEkeoNG/8A3vzqiT//1cC90m6szlkLr/eH9apc7CCACeg9a9JcIyKjAH5SqH/a7fpXLa3pgQrNajKnl48dD3NZyhbYuM76HMuCWGcfl3pHQjBI5PU1dbByflyD0qpNkglefasjVETICp4G4HoelG5SAJOPp3pHBLcAqcZxTwu5fm4xyf8AGpLG/Kq4X1wM812mgaQltA4n8vz5QGWQHgjGcKaxvDFuk2sRGX5ljRnwRy3sPfv+FdtdBJsp8pBbPmdMA4IYAeh/nW0FoTJkUWIZyFZihcHOc4buP896ntnL3YKKwQngH0zjIqJ8JCySAAgbpI26NjjcPb+tWbMqt0rEBW3bcZx9T/KqIex1MS77fDEYBrJ1GNgS2MIvT1zV5JxFGQUzznNUsm4SVejZxnrRbUlOyOS1IlU+23eIrCLKiQ9T2PWuA1j4j6bb6hKUi81wNuNpK8V3nxQgI0BLKEsqS5496+XrxTDcypOj+Ypx6c55raNkjOfQ9OsviGDeeatvHH/uk5P1r2H4f+I49eijhifyp4zuAU4LD+tfKcEiou8RFuQOO1eu/ByC7udbtLmDfGEZSc8VcloTG9z69t2M9pEqqTIqhSSOD3Bq9ZWqqwkQL8w+8OopdMhUwJIWB3IBwe9WrSRQHOCACee1YGmhx3xigluvCEttEMyO6gEdvevlq4ALy5yxBKtj1Ga+rfG2oINDkuJzGBzsEnAJ6DNfIviW5eHWpn+6Wb5k/wDrVNTYumyOdU4KbQh53DuOx/xqERAsqsgUP078/wBKmR1kCSREFMZYenrio2AwxLfIRgbOOPpXObWFEZVd6hgx4JHp6j0qnIoMfGUAOT3K+/0q2rnORlgBn/Z59qaSGLP8vK7TnnB98fzoBooSQbJGL8KuRj+7xnIx2qKRihCMQRtyuffkH3rQyUUIindnGCM4HtVeaONvkXoM4Yjgn/GmZ2MqR8HzVUq/c9iKryuHByMep4/Wrc+8FiVIKj5ueo9fcVn3AIchcL6kUAQPCMggnBGab5PufzNSyM2RuMZOO5INN3H/AKY/99GnqB//1tkbmuIBtbnpuH0/l/I0TBZPOZVDNxtYds8Yx36VMkpYBt23JzwM59/5UyVoySScI7Fdx49M4+hwfzqiUcjr2m/ZX8yHmFvx2/8A1qwMEb0I285zXo06o+EICyeSUye5z09xXGa7Yvbzu6DbFu2kAdDjsPTrWE4W1R0QlfcxxjCg8sOp74oYYGDyfWpXj+6OAe5Heq28qxDgbc9qyNTrPAcZbUGeMfOo2ru9x0x7118dtufaJCH5Gc5AJ4OB/nvXL+B0AtLxnzskbaxU/MvHB98E5xW6twd7F/ldn+bafuuOuD3B6/nW0djOW5JdmMxxHywpX5ZB3Bxgj8/8807zUV0kfHzYLHH3WwOlV3VZWeO4fKuehGAGIwD9Ox/Cs1HGzZcZ2lmTPckdQaYWudxaXUF3CURsuBk+9V4mMc7LnaX/AIs9CK5fTprpJTKhbduwT6jFa39rA6qbN40RkCKSx6uf4fwqlfcjlvohni+2jewEkw34bIJbOMdfpXgfjvQ4p9Qe4tWETuoLJ2Y+tfQ17YjU0nWFVynG09BgdK4rXfDqm/td0RiXfsMu375C5OPxIFaRZDXRnhmlaFdvNl/3QBHPrXu/wxt7axaFBhpFIyM/eNZkPh1Rbh7iYyJmNpEC5Zd3Ug9wCR+teheE/Cn2aczLCsflYxk53A45H4U5ajjaJ7Bo04+ydwcZwR1q5bPH5RDYC96wtOkeCyjLsxAIQ5P5ceuKmnuGniVbU7N7YBIyOO1ZsVmc18SL2ya1ZZp0JjyFSNwGBxXzprcMM3mE4khwSFJ5xngg9Rj0r1T4maNLpV79o+f7JcqSW6lXB6Z/UfjXml4wMk54+cgrs5VSOufr+hrOZvBWRzT2j6dM3lr5lszA5zynuaJvlmbDleC27Hv+np+HvWwp2SbSv7rJ+XPPPQe+D3rMvYkC7ShRowd/X5sd/rWLRoU5SSflIDjDNtpiXOPmPUHOM/54qGUNu3q2SUyfb0z7VWSRQScEDdgoTk5NIRd8wIuTzt4BHVc9B7j3pVzsAl+dTyQvUjt9KpGVdoXqRwN3df8AGnzOwIkThwc/NzkDjOPbv7Gglle/bMjW8p2FVLI/19KzyxReAcgYKkYzjvjtVu8lSUkMVUhRtOOG9Oe1UpCkm/eGDL2zz+NMlh55JO0EDsA2MUec3+1/33VZo9+CS2cU3yf96nYR/9fZSTYiQxHOw5Qt2Unj9KS73R3brIm0rh1/iGcf4E81JLbKkJZW3KNwUsc4XPAPp1prvvlUqsYKIduDnevJwf1qyRpiSJsk5Yx5jU8k46f4VXvVLQpKNjiUqJFkPAweCPz/ACNWCipGsy7dsQ39z8vcfnx+NQSKv2Oe3Ukr0SP0TOVwfyH4VLRaZwl/F9mup49uzaxwp/pWdIWO3KnHWuw1WCCdUjuARMrAO6nJwRxn0PQGuWvLdraXEjA5yAezYPWueUbHRGVzqPBZUWM7kZVXJIbovGM+9bc6wxGKNSUiUfMRzx2b3OeD9a57wjuW2uJVGczKuT0xjnNbF0zi3hUM3lLnAbHQ8H+v6VpHYmW46WUMi7mEZOY2RuozVS9Lb4pkyZFKknGD0wCR7460MWZBKoLsQEYnOMj7pNWVgdp0bBJYYHHUdOfypivY6HQNOWa2ABILAk/7OT61lal4Hvt0ElrfxbbZ/NVmT945GSAWzjk98V6L4U08PZgMvygenU1sXmmR+QwfkegqoysZczuea6NqV5NoKHULI2mrSSkSRL8y5LYGGHBGOc0/U/E0dhp0lzqFuEtIGI3TDGSG46/Qn6Cuxs9P3z/MoSMdB3rQv7C2j06YzxI6AZ2soI/Kq0uTdnKeFNR07VZ2TT4YC44dRgkEgN/WuzWyl+0wiYYQkKAB7VyXhTSTB4jN8USMNESIkUADPc4716nZBLhE3LgjB5pysNO5GdKia22FS27rmktbCK3KpHHhB29K1gMCmSkKd46jqPas2O5geLdCttZ0ea1uYwyMOvcH1FfMHi7wte6DqJimVzAf9VPj5ZR6Z7H2r66mCvFhT97msDV9GgvreS3u4Vlt5B8ynt7j0+tTYuMrHx/NgRheNud6Y7/571XMmyRLlgCXXGw859QO+f6Gu4+JXgyfwrqwaLdJY3GWik74HY/7Qzz6jmuE2jYY2YeYuWTuM+g/pUNWNk7mJdo1tM4YEnJ2uvX14qnIVkHyqNm0uGUdD34/p2rZnhWXKFhuYEdeh7fn61g3IeCZsnaRz/kVFgIfOLc7ufZunpmrCSFP9cqk5PIOQKpEjaxQfdHKf3cntUaSGIYYgIT2OcZPUUrEs07hldslA7epGPrxVGR4235CJKc44x78/wBKV7oYDDIABODn9P8ACopwroGXGT19QPX2pksq+aVJ3+YrZ6L0FHnL6zfnRKJFfBUN7hAf50zMn/PMf98LVCP/0NqORIJmjdgUcEK5J2src7T+tRWjopZWKpgBS5O7nOM46kZGM08xoZpE6SBSoZuQCex+lQXjM1yJgESNkBOxM456H2yCfXmrEkOWRzdNbkZyvybj8vPGM/yqsWYNK5gdjFFxg/KRnBHPfr/SrMbh41ZlAeJ9n1HXGPwzVVgsu5UIjyxZWJyvXnkfh9DSGiiyRQyGR4t20LkE/eT+LA78HP4ZrJ1aFCht/wCHeQhAyB3HueMmtuWVTp9tLHtJRwjEN2zkDPpnI/E1nSxpJauIkDMGLIu7p3A+mahq5onYi8LToLG5sLgERbzvbrsz0PuMgVqyb2gjlkKZDbHTPU9D9OoP0rLsp44A5Khre4QKzltu0Hv754/KrG8qyGeVvKZtkjhBkMOenr0GaldjRrqXLKWSedbVgDFPzsPbB+7j2rr7HS/KiHGT3PrXO+FoC2pZ3vIsZLIWUAjtg4r0KBBsUADpQZyep0+jbIrKPoOM1rwwpKhL9/WuWtZSNozworQh1CQXiRFSYyMk1VjNo0XtY4ixj6nktVeZEmgKMAwY459KNTuwkBVTgnvWP/aGyMAcluB/jRewJD7u/gtdRigQAMzYz746V0dtcMl/bRnjd+vFcdPbie7tbgpl0kD/AEFdpavFJEjSD5gcj1FU2g5TakcIuWNZN/eMAvlDLGlneSVyGysfb3qpPn7ydR096QEttfjzTC5wyfLWqirJHkHJrFtGEjbpIhnPWtyJgUAAApAec/G7Txc+B7uQorG1ZZ8nqoB5IP0r5bvgDJvQhWUNuA/Tj0Nfa+u20d7Y3FtKqvHKjRsrDIIIxXxl4ks203Vru1GVmhlKMD09MVLRtB6GDLKPK+dQpxnk4A4+7n096r3KiZPLmAXqQSuWx2x61cvB5kKhsbkOGXjLcdfrVS4ixGisVIJOx+cN7E9qgs5zUEaHaHGM8q6nis5rgglW+YeoGOa6O5TzI3WWIqQTkAdCB+hx+dc1e25Vxn7rcrTViJEsbkmMt3zjHPNSyu5XHBbGCPx//XVGElQN5wwIG48gZ7/hU8UgkJGN7YK7lPJA9KGibk8UihNrZO3jOCad5ieh/wC+TVZpXQ45b3H9fem/aH9H/WlYLn//0dNJ088xoiIkknILEq3H+A7VVEDyozQqdtvkMGPLKJPX6d6tXUYfE8K7W4BGeiMMZ/A8fjSCfNos+SGhYwuwBG1SMrn19D9a0ZKZL9oBaRoliZZcuhT+8vI//XVGWRY3ETj5IySobjCE5B+vanXSyQyxKCrbc+UQeSmMgH8SfzqO+DSeWHYNIWCqeuVHP9f0qCkULiTy4p87NgO51HAHcnB/PP1qrzFdKjyOFZcqzkYJ/p61bt2WSZllG9JA6SoQe3Q49CKzLk+RFLGFwYMQbmOcjJAb9QKk0RDe4yofG5AVKg9Mnj+fWoobktZhA5LLMyE9flIIwfoehqG83LcFo9oVEyDzng8jB9jVQ3LW7vJ8wRuSpPJHFc97TNkrxPTfCS4gMx+V5CN34V3NseAOBXBeFmC6XCYyNrEsMe5rsLGbOAa2Rzy3Olt4gUB7fzqfYyndjGP1pmltvUVoTjbHnbmqJTMi+Uy5JbnGKoRptYAgE9BVu8kIPpUESsxHSpNDa06FZCrHnFbYtshSxxisW1fFuscZKN1yBmughkWSPJAzQTcZJ0ANVS4yVHSrUxXsOcVlyXHkvgincbWhdi+9zitCFgB61hpdofxq5BcPJgRKTmmQ2Wbs/IfWvkv4xWjWnjW+dfmjnbzOD16dPfj8q+qtRkaKzlaTAwpPJr498c3c15rl5K7h2MhHB4Azx/kUmXA5yfMiYRxlcuOc7fXNMkAZSEDlM7XiI+4fUf56dajDsjjblG6FsdSPWllHmOGjX51+Yr1VgeOR3H+eKg1K1wzRyLHIS3m8cc5UdMHsc/4Vj3yh2KSgbcHacc5Fb9x5LLujO5MgkDkx+x9v/wBVZ93a+ZCFYjcQGBPp2xjpQJnJSORmNuvf/wDXUMUjRtlTzV++szGFDMDLkDB4P41mkEHB4NWrGUrmnDcFoxtIXHBz60/zn/vLWRRRyoVz/9LYZIftkieZtUuX8tjjK5Bzn0HIqqSx+220YbcreaF2g5VXzjdU0t39qFvM6IZGGzKfwA5GR3qGeTbPCyo+GUps2An5RySPbj+taEEjlGsUljZ12L5ahlGeOo/A1SnkBtYpolQQIzKyklSuQCp/nUMNztiuY1cZGJ14yp2nkEDsc9aYknnJNBEC0JJZR0JH19Bkj61LKRWuZERwYZDlZcglsA5HTPbg9apamxR52iQyJNtUrnhX65H8/wA6kkHl2/l4BIwisfbkZHbiqcgC2aiJ1di2/buwQR0HH0P51DNEZ090rxMXbAU4xtI4wf8AOaz7oEx7eMklgxbr7fiKvSndIjSAhHG0jHXJwf1ArIbcqnyySc9x0IJ6Vz1VZ3OinqrHqXga5jutLhERyAuAD1rtLNJFYcEV4/8ADrUTDqDxlsA/Mo7cnk17FpMY8xiX3yMck+g7CtYao56iszdtLnyUDMce2adeaySMLwv1qNoo5bZiRgjPFYFwqJJwTkjOM1ozOJee8dkdlwT1AJq7YTs8alxtbHIzmsq2wy7TzWhbRkNwcD0qDW5vWVxmRcmtlZ0hXLvtz3rlkYLJHnP3h+db0UiSnblSyHkHmqsQae7emetY8oMt3JHIRxggCtlE+QcYqrdGO13TOAMDqewosNspN5UUgj6t3zV+PUbe3lWB2VXwMVxul6suoahI6Hcu44/OtDxFLasiF0b7Ttyjqvb/AD2q0tbGbJtc1XzrS+BZAqKwWQHjp3FfJ2vSGWWZ2U7t33uhYZ5x/n0NfSOrXTPo1zHJ5eTEcqMnBxXzZqcaMXKHPPBXqRnkY7EenpUSNaexztwcygLjGT8xOfb86sIWXYQSGjzg54bjpj9cU+4QLI/l5Vn5Kqc7Tjj/ABqDAk4JZHXC59fcVmzUiMgDJJHM3mfeaMc564yafK8UypyoGBhWzwPXH+fWkR1LF0fbOpJfJ6544z06CiU/Z5mnWNxHg5jPPIPIP59PzoEzMv7YmAO4bzNpX689Pr71zlxGwZhw2D174rsjKHDIpDx424bsf6D09657VrRo0V1yF6hj/EPWmiJIxKKD1orQzP/Tvacpez8wZVCflEi4K84z+B4/GgCdoZI4laN495JduTjGRn6kgj3ohu4oZrR8AC4XB25JII6Y7c0pkka6ebkNIxMwLDG4YGQPw/SrIKrxfZ7uxk8lWaWQ2vTHBTdx/jVWAMs6R4fyimAc4+bPp74zUlyFubW6SCTErxll9mTG05HGfaqkrysr3DlkZ1DljzhgMbvxGD7UMor6kZEj3SfM4XMjqucP0PHU4BBrIAjeJnkXCjEoG37qk85x3yDWnNKwslmcMJkjMZKjhjnOf581kXieUSweQRSDHuMgYHHUc1DLiU7xTtM0QMhERPJPGPU9jg8fSsm/cbz2bg/KOBx79+a0Z7wSecHULLGNpXGNwzjbj6Y5rAkmLlnZiMMQwc5+lY1djam9S5plwbXV4mjYqhfGDwff9K9jttcmj+xxRSBGZxk4ySK+fzcPBcM6tnDBlA717F4dnN3pNtcbjEyLuJOCcEetOi+hNZdT1nTp499yvnmR5GztP8OAOK5bxFe/Y9YtTuwjZU/lVjQy15KJoGVIwNvPVvWsPx1BLLp8k6AiaElse1bPexklpc6qyPm3CyI3yleR610FqoYCuC8GXpvNCtZ1PJXafqK7bTZm8tWfHPBIpWEyxMrLKp9DnIra06WNJC+Vy3UjmsmRwwCk4ycVfg2AcgbQelFgudNCylQe1cT8UNTlt/D0i2ILTz/u48d2Jx+nJ/Cuhsb1Z4i44XoPpXG+PZxPe6VapxEGMr4/ugYA/M00IyPDlqdIsbdZnZjwGI65rqbe+B1KGKVkkhlGAG6qfWsLJkn2pkqFJHHB6VFp9vNJPiRSThjGc55x60oattlTVkkW/iBLb2WjXPlOsR53yYx1Hb3r5tuVlWdo48CNmJXI+YHHUfyPNev/ABYuG+yrbO4ZY1GecjcPX1+teOXDIzPKq7gv8LNy+cDHsOOtTIuCKFxH5riVNw2rymSVGDyQe/X8Kq3ELMGkRggI+Ug9uwz71duW3b5ImOH/AI8EbT746DPBFVBG0jCNuCCSQpGf96oKI4pyz52qZU4bPByOCMe9LKSYiy4c4KeW3OfbA6/1FMc4hUpJvTaNpPD5znceOuO1PUsJnmhil8tSSycEuh7g9iP60AUGjaKXaCD2bb0HufaoriYyWpjnUODwB3Oex/Srlwjsd+wLESxJxjPrj3qC6jRMQ7fmjPyuDjIxwc+lUScncQGKUryR2PrUe0+ldY0KTBXeKZ8j70YABpv2SL/n3uv0q7mdj//UdfwSKlwIieWcrswShB4+gxmpW/eXLPEoWPCyg9yvADfn+dSpEFmeGNpIlkRSgIyc8g/UDvWatzLFp8ckMXmyWw2uAw+7k5Hv2x71ZAWTPbavc2srKhlHDL0bPBX2/wAahWXyofKEPyECM7jwQpOBj3GDRrTRRyRzfIjOirIEJJUHvn1qssgW7UOSFlGe/wArkccn7vANDKWpHESkD7xsJJwvvzj8Kw1+awXy5csIwquOd7Dg5HbGKuyORfKm9mDDJZgQFJIx/L9aqXDyDfBGoMal2GR1QnOAOv3hWbLRkySKFuUaMhyMEE9SRj+f86xdXZYVkjB4BDZ9Afatq/iBJfcCowgYjAbpyf8APSsTVG3IwCfKBtwPmbr6/XpWc9jSG5jTSF2QZGCuQfT0ruPBV4Lqxa3muGWIEqVzzj/CvPVfAAA4X5hzn8Pwrb8J3zW+qwKCoVm5/PrUU3Zmk1dHtnht2hsjIPOWON/LTJ557n616Ra6bb3ekoH+YyqW+bvn1rz/AE65aK1eIRM4Y8EDOK77wrJIyoZEbByTnt2ArpbT1OXVaGFpGj/2Jc3VggxA5MkI/u56j862dNlZEEUnDHP5ir2tWzyQJcgfvo8kgdcVl2cnnYkBHzfr7imJs1HlQn5jgg5H1xVqxn8yM7j1yKw7rCyeacdDjnvSrcsiAo2GOByaLCudbauixMFIx0AFcn4hcPr8aLghIOn41bt7nyIWLnavauRN9Lf6vNfIPkDeSoz0Ve/50dATOr0bzEkhbb+724wf8/5xXQGaK2tSqQ7H5wAOhrD0dSSF7YJwTxVm7vQIGiUF3PGQOlQ9Cr3PN/iyp+yRTRqpI4IK54PpXj4ZZVIDb2JGOxIGcrz06V6/8WgzaHbyqSMS9uvTt/OvGC7wyFCFEe5nkBHDHv7jrSZpHYluHTykmDNtIKscZxxnk+2PxrOlVS5Iy2DuBHJ46irZkYXEyhQyhQd3UkeuPbn8qiZAchVAQcBVJyV9R9M8VAytIqSkgkjKsZIxzuXuV9O3SmDiNCmTj5VKtn/JFTSo8PmKwYtHjbtGS30PrUabgciNQECqwLbXYDONuO1MAmjUsjuFMRJDAHJB7MPqexqsmHKqw3OpI3KeGGPX+VTxuZYGCqSrcOd2N3ufQ1DGPObzeOMOseMYx2x7e/4VSJZXlHmENGrbMDaAcbfY575zTPKb/nm//fQqw0EkmCvlHAwQSQQfTjr9aT7JL/dh/wC+moEf/9V+rXIW3iuI4PkidY5SDuYK/XGPQkVmxQJbC8tottsu4x+UF4CkZDAdSAcD8afI32nTZFeRTNGjAR4zjnAA9e3SpBseG1aZd9zsxKytk9hgnt9a1IKlvJI9neJH5anYpBCk7iP/AKxGKz2lcQF9mfLbs/OcYOfwz1rXVo3nWMSL5K/w4x1yOnsOOfWsYDE08TxvuXdIMsCT/DjH4ZGaljTEupH3QyoiTQyhFdS2Pmx29iMfjVTVLp3KvIyfvFMEhC/d9vr09qRIIjMjkxl1K4XcRjJO7B9sAg/hUM0ocNDOyScecVAIPzE8fljk1DKRlXbPKqq+1nHUk434Hyk/WsO+uNzPHHtDuN4RhwPr+BrTnPJjVWZ1/duR/EMf0zXOXgZ5k/ehsqFOOAQO38/yFRJXNIszjjePLb7xAUHtxU2kH/iZ2qnCkzIpbP8AtDNQTBhu8vG9GyCOhFRwyGKdZUK71kyMjuOQf5VlFamzZ9M6XcfZpUP8LcGu60C/Vup56jivLtJvFv8ARLW8jG7dGrkH1xXYaJcB5U+zFlO0ZDDitkcskdyxDOxyTuGK5G+T+xdWKfN9ll+cAfwHvj/Cumtnfy+gVs9a57xwhntUnif94p456itETuXcW9zDlSrg9s1nQRNHdnjMQOQSa4zRfEZkla3kypQ4IP8AjXVrfRLbxSTNmRsgDPJwaZNmTeILsQWzyM2FVSQormvCtx+5Unnc3I9yeatatK92hVsBT2Fc0rTWk6SxMFhJzw3J9PwpNlqJ6/prQwnkEZ7U3Ur1lSQxAEYOMH9awLTWlkixkE8YI9Krx3Et68kok2RjO5ug47VMgXdnPfFi9DaNYW8LR+aZRIQ2TgAdfzryW52TzyRFNr5BVtx6ZHygfnXQeNtV+2eIWyWMUQ2pjJAx15Hf61zsrI7hol4Xp33HqOf6++KlmkdiNchpFCOYwNqknlT6HuBzj8ajeVonuA0hKSMDjbgcdh3xx19aV3uWlVhlZy+LkL09VwegHNMHly2zCNlAJ39MnJ4yCf4f/wBdSUEhcuUCvv3HapXBcYyVHv1qskK4435T7jEYPPY+g4/SnDO1jJJtIbJZm3FD2I9AP602SSURfOEEvTZjhhzg++aYmQkCOO2cqxjILMGbAUnkM3cHrxTZiH8qRRKJCBv28FgPukD19vzq0uLlWjHVCX3Nxt45IPrg85qusw3JDDv8wYCyKMDn0xz+J9KCRC9szN57SRSA4Kgnj8uPejNl/wA95fzahZoYNyGd4GBOQqAhz3bPvTvtkH/P/J/36FMLH//Wq2trKl0Y3khjZBuWJVA3sPpnOQAfzrK0m5jW8uopbcqszsTvf5Rxz9Rnt610M4+2X1vFbOqA27hT/HuBOCAPu8ZFcrcymPUhcTTtLHMRsRh/cyu7/Z5x9a0M0XobxXkg35jmbduDNyGz+vTIqO7mQ3iwQ+ZvkB3SOMnIIOPxBFLMI4wTOsjeXtdpEGNjHjv1J7+grM1cOYdieZl0wsg53c54/DGTSKIYZvKuwAokzk+WRwhPG0/kf8Kr3jfZkaVFQpFIEc+gY9x3x+lTS5iSW9ib91CBIzMAccZJJ9qzrm5W4XymDAyoRnJzux1J+mOfwqWUjLv32XNzbgNuYZQkdl4OffHasC7/AHUiuMKjJkA/hxkdK2b6VFjUFmU8Bxxkf7RH61jSlOYhnzFIIBHT3Hp/9apZSZRkysjfL93GOOSMVVbkbUJ4xg/pV8KGEcgKtsGCSMhyen/66hn2ZUgg7gdpxjPNYvRmid0erfCu887w8YGf51kkAz6ZzivRfDOohcwyna6cc968g+FzxoTEG+67cnjORmvWIdKF3AJIH8uUDIYevvWy1MpaHY6dflmKyuCpUgY9R/8ArrmvEuotNctb2xLSDgKD0xWBNqtxa2/7+PyZ4Djk4D8f/Wrl5PGcT3l5Ku1SMiOTHfHP6iqt3J22LC3P2V3e8jW3kychjinDXvPeNFJKoDj6ZritQndybi6aQsBufdnBOOAKlkvhazQzncsRjGSB1Pp+VJsu56ja3cl1EP3Z6cEng1qaVpX2hGE6g7hjAGBiuV8MazHfxnyxt4G3ntXoekyKEBJ59aZLkzKs/Dcttch5LrFquTtGQT9apeLvEUNhbC1tehG3K1q+OL+W00yR7Y5kKEqCcA4rxe8kkun82eZXcH52blRxwPc03oTHUoXTTXX2hd6PMhBQ5+aTnv8AWlSRVwGMocbVUA8/U/n0FBlLQxpF5jSIAIvl6nq2RSTjKrcW7uWJBlKrwgxnJHQHIwayZsKA0d8u7aGYheM4PHDdMEj370kpiieObarzhvLJGAwXqMAdf6c0x5FEcazIhbBYMxOSCehA+7+NJgRs+yMo2Spyeq4wDj9KQBcRbArhN7D94Ac8n/PP51SvMyIpJBkUhUG09MZIxj8quiL5IljITYdzB1+YHngZ6AjoajVxgyeaxJ+6VbOxvp370yWRI8KqWkKkDEm4qByOoI6gjoaCrSH918oJJUEHII5G4D/JzVeQxrHmI7UYlpFzu2kn72T7Zz9asyAQW/nLuXBxIwY4wOAfQ+lAFYy2ZSPzYWdto9Bj296b5mn/APPq/wD30Ku+TCVUuttnHRx0+nPTv+NHkW/92y/L/wCvTsB//9elqE81lLLJGCJoY2MXUjPB+p757c1l6jC5njTY0jkLLCufl2k/Mo9OOn1rQvHS6CTyQuW+0mFyDnhl/h9+gPas1pDIlncRxhfKdrKUjncCdoP4Y6VqZosZM8T2qSpMhzHuf5QCRknd3OCo/Csnc0PlJ5zO6yeWoIIOAcdOxOTUsJRlICLkDOI8hQOAPzK/zrIubn7RO6gXGCWUE8c55PHX+lIZZuGa1imidV3RHchkA3DIPPPXkVj32ZbeSKJ8MsIdGA7/AN32HFJP9qhaDCrLt/dK7ZyCCc5JPWq0lwVeKdVZR0fcepY8/h7VLGZd3KHh+9mNkDL2yD3JqjCplZZMAZyCSvJIxjPp9KkvEMeEeTcqT7Sq/wB1uhH0zVW+OI3KOFBy6r1x259wR+tQy0TmJAZmQsoJPAAwOec/0qjdzZRh0IyOR+XNWgpfzHw3zJ849Scc/hWddTGRwwBXcg4Pt3/WoaLTO0+Fx/064JJKnC5PPPf9MV7ZpU5hhKBtw9a8i+GunyxweYw5c5x7dv6V6ZaRvbps3lifmJNaRMp7nO/FW+ddMhWIHM0vlsfQY615SQdzRYO0ccH73oM16V8TrV7rSIpM4WOUbuccEYry0sfMPmEb9vAx3B4+tTUvcumtDet7hLq3dZPvoioYwc9eB14yKVdqhoHYqSNwU8bWHb3HesvTSr3EayAv1y2BkMeg9Pyq/eDCPMrYVto3vy2d3X8OBUp3RbRf8KXzwas0C8IRkH0weRXselX6lBz2HFeEaPc7L9mZ8vz6duwr0/Rp5Vgh2HG5vmJq0yGrnT+MSLzQHwP3i8ocj0rx1SSsSxuPNQlRg8cdDk+1ewSIl5YtDKDscbeO1eXa3bPY30lvKv75W3Jhck++enSnJ3FDQyJXMPzwPhvvB1JGWzwT9OakBCF5YSYoy21huO1m6n255/nUV06G2KMWdlPHPzEkc7f51ExlW3hiIVjt4Ycqx+vU8Cs2aE07J9pkW1KJbSBfLxn5SOfmJ9T2p0b75t43LJgglucDPIx29PXmoVDi2ghmiKlWZkZ27H+friqzlhL+/jkJdvukAfMOjccdPehCLkjMxDIS0TgDnB+bsCPpio42YySkEjIPQDPXgjsB2oidnKy28e5wGVxwpcduT9Cc1HNJjaPMUshyGA+Zhj7o9896olk0UcaTSlGKu2C0bHPJwMAdMe9RQrsllheML5RBAYfe5+6M+nX3pAY7kxybJN+CfmwF+gHtUlwkUbmTAOzHDccEdvx6fjQAkX2iNMQmEL1w74IP5U/fe+tt/wB/D/hT45l2A4ijHYbhjFO85P78X/fQpAf/0OP/ALQuJGS6nSNDPG0Mg3EiNhg5UDjI9abMjfY3UyKRmOVhuILbT8zYPA65/GmLGzC3iiyNzNHcBgVIGM/UnoO3eltpo5ZPLllYEQsHBB2vjqPyHGK0MyCe8CWtxcW7BZIAcqTnocjHoQD16c1Q3iaTLNEJUYg8FcZG4/j0q1MDbwyLE8LZ25VPmcqe7H2P9az7xpppGlBVHjkSQucDKhcALigaK9xIRaLvw6m5VuGO8YxxnvVGebzYpztIDt8xLDAGScipdTtw8zeYzgySbhuOCflyDx0zzx7VhQyLLGgcZlYfPsPJKnnjsCBipZSH3Vwk94+yKRIwo5PY4wf5Cs6MqsARgG3A9OOOhJPfjn61ZuXLK7JtypCAk+/p9O9VVUiQRAfN5ZUDOc5PH51BRbWUQiInJJx94cEdCD+HNUVi82+WBSeHwwxxtzn+VWJnEkSq5GyMYySO9VxK51GBwcM6jdg+9FgvY9e8P3C20UESKAWxyK62F/3pDPyR09K880q6jFxaR7uBlmPsB1/OurjmiENxdbiNuAc+gFWkSzI8d3yTaDcRocFZRyR1A5OPfGa8uZ3SZXVSSuMMRyT6flXY+O9QV2gtrYkL/EF+nWuSkJWRpF8tE2nDMehGeg9+KxqvWxpTWg5WZXU8fIMAggHk9B+OK0NOuGks5FYRmQExsqnJAPJbP1rB3lEQFcHbsGR0GfT3qa2uJre4EisVXo68cg9amJbLjSi2uD5Z3Fm4yPzr0vw7eiS2g6EgA8eteaa+qukbWysYUUFnPcn7pHqDmuj8IXCpauJT90YIz09q0RDPW9LuN9oJenPftWB8SoY5bRLxUBkhwG5xxnPPtVfQrq4eK4UufLUkf4Gk8QXJ/sImVsyMuDgZ4BqiepxEbGB0QM4aQFMk5OT0I9AKqxrI8axmVXIDCNgcPnpyenPpU0uZhvdmIjDHzGXnJ44A/Dk1CLlDNJKIj5WfKPmc4HTI7cVmyyF4laAbSY2UhzyWYY+U59MUjhhE26XdufDIOxA6g/lU9zGkDOh3MxOFyeWY/wAXp0qCdRHcKIgpU/eGcDHr64/CgTHzTzRujvxxtCsQd3QkAd+lTrGsNwJoNzCXjYmAyDGTk+vNQTKVvokk2+Zjewzk4OcfTp2p1hMsbSq6ICMMSeEJP09RwfpTRLGXTuy3JMYldTlTuIAJA5Bxzx60oKwApNuLScFnU/KcdMenSrtwrSndLtiiyw8sZXkY+bj0HaqaSPIZFaXZMzjl+uOn6imBYltoC5DTS5X5cIh2j2FN+yW//Pa4/wC+DVfzhF8rxrJ6ZY/KPSk+1p/z7J+dAz//0eIs7sPE1yxkZfPLRqMlgCSp5/8AZj2qNWlhvFElujrG7wIuc/Mw35H60ac6R200AEgdGYjzBkHAyFx7AD8ahvWEkMV0hybiFZsrASwbg9c4B7fStSBodFddqlMkRsH55x/I8Z+lQ6hMkSoFDvb3afcIH3gMcY6DAqzeS+Zps86yKEJWUYGFPcjP1zWLfxqmnSFuEiYTKH+XdxnPHUc0gG3W8Rx4PmPEQZQrg5AO0En1ya5i8jeOSTzEJQMGC7sYyfu/yrVubiNvkHmLBJ+7YFQvvj3zmsaQ7IFEo2oG37Qc7sr0PvUspEU8QQzxh1McijaoJPP/AOuoyY+GjG5w2w+rbe49hTppSDCxyE3CNsN97FL5QS4nTaEymVOMYz0+ueagoLeXchKLzMCWbbnYCew74NE6swdmj/iBLnqO3PpUaJICqSlcn94oHU5PT8OKuTSATKy7t8p6Y4IA+YCgRqeHL82xljvPvqAFz6f/AF81t6hrrf2XdQcHzFbODx0ycGuTUNtESpgEAJz94Y9TUDFliClo/M7Acge2aTm1oUop6k15dTXUhLMxYYwAeDx/niq6E+cnlklj1YdARxgU0bgRLCXQEABcZz789KXAAM3IyclupPHH+NZt3NELJtciY4EmRuHrg/zoz8zjP8W0DOMD3+vSmXCl4CWRdjMzADjB9fekZS53s+GztyePcHikM07KR5bV4Pm3kgqM/eHQjnsMGp7cPZtiNzLCw529gRwff0rMsZ3jmU5XeOCzDOcnBx+Ga3YiyvGJH2h28vjrtBJBFaRZDRu6LqrSxsFY7jIhbtxgVL4kZzYSRiRmU7juXIOM9B3rmoN9soeMDLyY2pySBnr6DpVpr2WQrIHKggqrnoCSRnn/ADitHIztqM+0qdNMRcfNjzNmV3MD1+mOKJGeG4iRW3KQyqvGAcjn0xUeRGUdspBIhjVn+cj1P4mpsqsO12UFMqTt2gZ7jH5/jWZZG9r9oQxxDdKp3KxfhYx0P1zUfm7pwZN7MPkdcbA3oRnk+uaeMmZJVffPC2xUZtu5O5PtRIFiuknCqSVbqS2Rnjn0FMGRIeGk+0J5QBVmZtzH0x6dcU6yieW6i2HayN5bKgyoXGefbNMtVR7aTaqJchvNQspIY4yc1JHtaOCba6x/e2s2N+SeDjvn1oETWbM7hnkJtSXVzt6jPT86a7Ml08YOWwCCB8ysAfyB7UvlLIA0cu5wSyxrwgcDO0n6elOsGNxAJCpVfm2ncCRnkr/vDFAFT7WqvIzMWkdt0hPdun9BR9uX/Iq2b2GABCrqcZIBXqfwpP7Th/2/zX/CgNT/0uHhtoYbvU1jmcqr70hXO7kc+uRVCQMNHMSnKrcKu4HB2sRnIHfGRTkuxFqMdxYo6t5Yi6bQecFR69Cc1XiuHubW9tVXZHboSsifKHYc5Leozn8K1JRM8MUv2qJWZl8xljJOB93GAv0rNtD5lvG7ts89Dx95iF4xnt1zVuJ44bedh5bSCNHDucA/7f8AnrWWu55opIMxCFsb24D7up21NwMmS5ZIpc3A8xWAchOdwyOp4Pasq5OxmgTCwyLlmAw2fr6mtPUsyFgypyo+deCG6Bj+GKyHQqqvMAzONwO3OSTjd+IqWMnhRpoZklX5/vIi8dOlQ3DOskc+CTj94u7oPrTIfMbBlYjByH3YGO+adMyOk0KgiMKCvHQdyx9qkZJdFBNHI0jNIGxt3AbVI9v50+MsYp1i+bywGDvxgjrx71BMWubdJLeGNRgqcnkYGPxqdZSl3CoPyHjp8pBHP1JNMZJ5nmQQFWVir546AEYz6+tQ3LMl1Lncythsk9u54oUeUJ4nCFgCoOOP7w6fXmkD5iQAAqUOVA5x6moktCojXyJTHvbbyFwOmeeKkmXcknl+YQPuqoHHT/69Q8ZG0g7V3ZA6j059qW2kEIBkOVAyuT+fSs2WOZwUTaNrLgNnnjGajeQefEyjh1AK5xSxAEFM8qeOOnPGTTHOLgfdKEc552joDmgCYKRcqpJ/u4GCT15rVtZJZ4I13/MIyjMFGMA84PsKx7cCJjGjLuGW+XnPt+lXLa4dUjhOAQBt28AZ6j8qpOwM2YJIyrGBFeNztXH8IH3Rn65NWXMiFYj+8VlCu3BXeBkgCqVozqrxh3KFt6yDuMdAPzpxk811aWNsn5imdu0dNxPqeP1qmQLkSiVpMRRFshzyQRwc479h9KjnchEWGONoUYlw5wufx68H86k/dm3KZDLK+0443ADg59BSxfOHG/OTyDwjAfwr684oAlL7sTMqusZ2gOODkfxDoSMYFQqY2eKNhtjYkDLYCSf3cdgaUEs0ilSXRmOclhkYyAOnekkch7dV558zJTqe7e2OPypgRRiMXKyGR1i3ndk5O4cZX2B/nVkKY1IAMQlQ4Rm6vnn8zzVeRhd24nlJd428mYspBbuCQOmev402CIeTsuQzRsQFYnqP4ST2xQBbhP2Vx5h3A8uysCFBPJHvTpo5YLxYYxtSdvmLY5bsQfQgVA8aMYvtIZWEZQ7DgbR1YL79T3qaG4gkRVSFRMqsAX4ynbJ/lSAbPBhx80kZxynHyn06VF5X/TaT9P8ACrMN9BbpskBkkySzYHJp/wDalt/zyP5CncD/2Q==",
                "title": "Image title"
            },
            "note": [
                {
                    "text": "Note #1"
                },
                {
                    "text": "Note #2"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Media"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Media",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "status": "completed",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "operator": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "content": {
                "contentType": "image/jpeg",
                "data": "/9j/4AAQSkZJRgABAQAASABIAAD/4QCMRXhpZgAATU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAOSgAwAEAAAAAQAAAUAAAAAA/+0AOFBob3Rvc2hvcCAzLjAAOEJJTQQEAAAAAAAAOEJJTQQlAAAAAAAQ1B2M2Y8AsgTpgAmY7PhCfv/AABEIAUAA5AMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/3QAEAA//2gAMAwEAAhEDEQA/APPNzscLnHsKFRs9/wATWisaY5yackKA8ITXiOqex7NFVYcjPFQzW5JGAx+nFbSxHGAn6U2W03kFhyPepdQ0hFJlC1tpWUAL0PUmtG08yzdWbb16ipba0G3AVifTFX4tOdx9zg+vFJVbM0kk1YqahqN7FbNLp5UOeWRlzn3Fc23iTV5/kWaQknpGnP6V3FrpWzLTsGA6AVdT7LEMbo0I6YAr0KeYcqs1c8urgVKV0ebGPXLw8RXsmfXIH61PH4Y1efG9I4x6ySc/pXoL3cC8Lvc+wqlPOzuTGHAPYkYqZZjN7IuGXw6nKJ4Ol2j7RfRrjsiZx+dWI/CemRjM89xN/wAC2j9K2J3mYAAIR7VGltNL/wAtNoFYSxlV9TpjgqS6FSLR9IgGY7NH7bnJb+dWR9ktuI0gjH+yBSvZIoJkm/WoWSzQDncawlVlLds3jQhHZDZb9c4jOR7LUD3Dt0Rz9TintcQp9xM0gu8rnaq1FzRRK7ySsMEKF9CM1X+zknOW/AVYlu2I+/j6Cqz3APVmP44pXZaih4tyB93n/aNIYDkZdR6Ypolb+Afj1pv71sEcUXHZFiO23MoLMad9lxIdoNVP3qydTVxZbg9FJ/2jSbYiX7MwwM4pTaAjDSnGOmTTMTEjcyj8aeIst802PwqOZgOFnCACSv8AOmy28Y5ErfQCp0SBRksSfrSSTwp91Rn3p8zGVHQ9FaT1zxU0UjL2pxuTjCpgfTFRE7j2H0rObuVEV5W3df0pPNf+9+lMKUbKgo//0MX7Ds+8yCnrHbRnEk4/Cs6QlpMZJ78mkUEc4FfOM95Rua6PZA8b5CPale7jUfuoAP8AeNUITnrtz25xVjygV+bbUtjUUieG+mJ+VY1z7VL58rDDzkH0FU4UijkBLgmr6xllyoIGMdMU4o0dkVlOSdwdvc0rSBRwUWoTCqyku4PsOTTmijxnyZHx+AqrhZEUkhYn9630WljdiRtDMRTlkAGEiSMfTNL5rMvDOf8AdGKeo7oXM6jKgLxVWRrhjh5kH0Of5VKUlb7sOf8Ae/8Ar0eVdEdEUf72KEguRBBjpI/vgAVRl2iTb8oY9s9K0RbMpy03XsBnFDWanH3mJ6Gmog5WMO6uI7dczSBFOQT6UWl1a3dtmCUv/ujimeL4YorGNTHvMjAbcdB6k1wd5cyWeoMlm7QMuSAuSpP06H6V6FLBqcL9TzquNcJ2Wx6CYyQdsR/4EaTymyMFF/CuGs/Eup3jMsbIHVCzBhjOOuP8O1WbfxXG0qJcwuAwGW39PY/jxWE8FUjsdEMbSlvodoDGv3paaJ4gflVmx0xWbaXtvcRq0XAJxyOass+xckcZxzXLOnKOjR1RnCXwssvcnIIAHtmk8+Q9z+VVopfMOEIz9amELtyZMfQVlYq6FaRj952x9adFKmfvZphjiXmRh9Gap7cQqQQV/AUJBcn8xQPmwPrQpDDKkY9aWS5hA+Zl/OqkmowL90Z7cVoqcpbIzlVit2WwqEkGQMfQc1Iir/dJPuaxX1QDd5car9ag/tGZ/wCPA9qv6nOW5k8ZTj5nQHrwFFHP+x+Vc+biQ8+a350nnyf89G/OtPqL7mf1+PY//9HlJnJUbWI/3RURt1kOTvJ/3uKvQ2pEY3MCe9FtEhTdgsD3r5xytsfQWILWzVeQOa04rfcBjOPc0qlEHRfxqwlxwMEY9hWcpMdhkdpsPAx/u1owxYHIH4mqJnIJIDEe/akF0emD+FKMmVYusiJycfgKQug9aqGRmJ/SjcqQvNM4SJRngda1p03N2QpSUFdhIYIQzmNQByT1ri9Z8RNJeMlvI8cK8AIME+/HatNGufEmoLbWTyRW5OAEGWb1JPYV1T+GLHT7GNWG+U9AfmYn+lexRw6oq8tWeVVrus7R0R5/D4jvbZMzCR0Bxh1z+tdz4Md9alQqiyFtpCr1Kk85HpiuVvdNk1W4FvaqRGzFRKoyAR0r2j4X6CmjWUUsiBWJLFV6IT1I7gZ7V0LD05Lma1MHiakHa5h3vhs2l4d6sIpMqCR93Jxir2saJHbWcTIgbY21jjn6/Su51t0kbAUFZB17Zqstl9stZYyMsE7j9fyNOOHgtkKWKm9zwfx3p7SWmWBhWOQAkj+E8V5drtnJHIPKQqNoKn0OcbjX1Vq3hZboSs0YeQZHz96xZfhbDfRSz31wY4gqxxRqo5Pp7iuiEUlY55Tu7ny9dW8trL5sIYGeMhscYVu3t0qSxsZUulnaLCYyDL8q57/UV9Px/CTTIg0rrJPMBkbuQretcN4s8NGCxmN3HEjQuRlPvBT6+9E1bYujabszyz+x7t4hIlwVycDylKj/AOvWrpdzJa3sdlqEoeVovMQsPmA9T/StjQIpHuYbY8I6l4/6Vj+IdJnj1gXRDFwe469v/wBVcdWKmmmdqbotSRpTXEEZGw5b/eqL7cx48w/QCsyWPY3UZ68dqZvC98AetcKw0VubyxU3sXbi5AO4qC3qeaYLuQ/ecnNZ012i8buaqNfkMFTDNnHFbxpJbI551ZS3ZveaT35PrR5gIw3Ws2KYsoLsxx1xWjBcwfL5iD3J6VooGLkAkQDkin716dM9Peo5Lq35XyV9ivcVOJ7Ty8pbtj34quUTY3ap6sRRsX+/R5lo3LBs/U0b7P0f8zRysLn/0sKMsynH8qaqso2gYA9amt42B+9j6VM0A98+ua+VbPpSsIWYfM549BVlUCqDjjvzT4o1JCkkn3NWUQBcbanmFYpvIoPysMntUJmVS3OT6YqZrMByzOFX0pPLhi5DCqGkNhMkoxtIOME+1Yfii4M95FYRvjbgsM9fyrovtAjhZxgBQTXn+mPJqV1d3G4jzN370DkduPyFe1l8LJzkjzMfO9oRNfw3qGqQassWlpEtgi7Wdl+99K39avpZpILM3WLlwS+xM7V/Cuf0vU7jRLIwSwRSopysoOMfX3q9osz6vqnmW5C3DEYypbA/CvRT5nc4U1CNup3/AMPdCe3XfLOs0AJbITBJPbmvQIJWkcpGdq44DcflVLRbBbLTI4C5kbGWZu5q20UYH7tMtn7v+FXcwk7l6wCtO1vcjcHHDD17VppbPZeSyLlBlH/pWRb/AL7A5WQnjP8AjXQ2D+Y4hZy3mIeo9KpEspXn7woFAUsxJPtVqF1uBwmYkYRrn+I1CkAkZI2ztVOfUZOK2IbRAqbWCpH8qj09T9aptIncYbcDhVLnuRiuS8X+G49YsJomgJZhyGI5ruLWBEYiJwFPPPc1b+zow5A9+KlyHG6dz5T8QeH4tBFm5DGZpMAddqjpn2pNUi06WGZ7hYw4Qk8V6p8U9FntZDPDA0trICSAuSp+uK8K1C6kMro8ZWIDO1uGb3x1rCpHqdiq8yszjLlx5rMpO0ms66uAoIyK37y1inBMQCHPJUcY9cVy2owPHJ91jGej9jXPYq5CXDBjuA+nNLb481RgnPQ1HswBnnPUUAbeR909qpC3NtBtK7l254JzQSCxxhVIyBVSC4dxnO7PUEc1O8sYUkj5h1B4IpkkgUnozY9M96VX2swb8M9v/rVCkzBiAA3cNUnmbuRjdnkUCJ2PJ2ybfYUm4/8APU/lVSR9xBI3nHXFMyP+ef6U7isf/9PK81Iyd0g/Ckkvrfb1yfzrDKqRjqT0zTtu1duMHrXhrA92exLGR6I1W1LbxFExB6E8U1tQlHDDbmszcQMAs3qMUvm/Ke56etbxwdNGUsXN7E5vncsFIGDjPWoPMaRiGJY549qYWLAngDuMU6JVDA43Aen6VvGlCOyMpVpy3Za1OHytGlg80iSYbSR2z2rIt0SGIRxngdeOtX7mWadl81AFXgBT7daoOMMO3PBFbOXRGVurHqdwZZF3IeMEV23wlt4IpbmCdw7k713LwBXDrIBwc8cV6D8K4EudSlZ22hV4NXTk9iJxVrnpV1PDDACM/U8D8K5ifW7mM77lUs7Z2+WadwqsPxOa3/EELiyne1VJJIkLokh4bA6V8q65dS6xefb9Tlnu55GLYZgCn/TNc5CL06Dp6mumCOZn0lB4kt5ruBBKqyA4Zd+5TjowNd34avxc6n8pDqqszEdu1fI1vfw2en2V7ZxXFvas5hkWWUOPMVdzsrf3McduR0619HeC7tNP8O3N3dNsMjAAtx8g55+tXy2Ym9D0B5FTU1yv7tgQx9OeKyZNYlgtpnY5UMRyf881Wk1RZb+KVmPkyEZI7GuT+Jl0umWt7MGdYAPPOznngnHvx096JRuKDsdSdcjYOsF0GnXB4PGfQetdb4b1Ke5iCXagSjr718i65G411UvX1CR3UStFalBtLD92oLHBBGcnjBFev/AHVb+W5vNOnnlmi8tZ44ZH3+RyQVVjyQcEjJ47cUpRshrVntmtRwPplwbtgkKoWZycBQO9fIHi+a0utXup7BRFbyOcdSWA6MT7/pX1X46VpPB+pqkwiPkt85OK+P8AVG/fOVbcuMsBwR/Q1zzeljaC1uZzLuc4wrMSeOlUrmAyRY4OOqd/xFWXYrCrHYeMg+uPaqbTksCoLHbjbnkEdxXO2a2MLUdPZWBtgXBySueRWZgqMHdkdcjBrqd6vkr8r5wxxwfr70y9t1uvvgK4GC2OeKdwRzkMjRkFSVPQ1ceSKRAwKt7d80y8sJ7bDMNydcj0qtbNHFKMgYJ7800waLSMM5UN6+mKkYFyWHDE9KZLcKvbrxkVXeZlJIG7+dUTYlJyxyxB9M4o4/vn/vqoo7lWGQ3/AI6DTvPH97/xwUwP/9TjdxEnC4wepqYSA8sxByMDGc+tR+WzksB09T3pgUqcuxB7c1zG5MJdnXkk4ORUMj4bKjOetPcgEeU3JGTmojIxcgjkjOcUDQ1yMl1Yqw4IByKUPgcAk9M0z5cjHGe/oalChQckkfWkUkR+YwJ9DTZj0AOD6GnYGSQeDzzTRG80qrGmSxAUL1zQtRjEBOG28cc16H8MpoRf+WJQsmCSrLwfoaydI8LCRS1xMNy8BAOD+NdfpVvb2Bh+zxqEY8kDOR/OtYqxnN3Ru+K5Xt7N9v3ACcpwenvXht7pmmam7efHJHdE/MyNtDnqSBXu2sQ/aLBgSWymBXA6b4WWHMly4DAnaAOnPAFbxkkjFK5xGm6Q13e28V3aGKziyVLSliF6kFTxg121zfTDTbe0jkAjUD92WBAXt/Wpbu1WGGRp2CS7sfuxndWPawHyZfJTEof5zIcEk8gj61akJxOv0jVZJ7dYWYBVTHoRyAcGtDXtIbVNPaHe0iqu9VY8M2OCe/0rk/DojS8EYbap5bb1HPTFeh6CVkcRiQPuHVh0puRPLqeX/wBg3OtXIg1UCAxxkR5TOUz0BNejeAdKt9FvrVNPfzZW/wBdKrZz2x/TtitbW9HnjQpbRZByw4HX29D+hqH4eWlxa6xP9qU54Ctsxj60nK6G1ZnovieOCXw/cC7iWWIJkoVJz+Ar441yJ49UuAFaMiU4GMYGf8K+t/iFqB0zwjeXETL5gAClzgAnivkXViZbmRnbexzuJ6+//wCquaexrBGNMrqoDI2GJClewHof6VSdQoySAT0IFaLvtiwTlf8APSqcw3yHbux78fiPesGaFbZgZkyOM5HXP+FTkB1UHI9Dnr71Lt3YCqSBglum3j9RUZ+TIPBxlfQeuaAEyQ7Zwyk4Oe/0rN1LSVZmaHapPIwML+PvWnDIrRyqvEqjGD+n+elRTyloyGwpPcd//r0xHMOZYn8iVcH1b/PIqKQYfA4Y8+1bV9Esw+YZboCO3vWPdQeXnHKNx16VadwZXC7hnbz3yKXy/wDZH5UZCgAEkeoNG/8A3vzqiT//1cC90m6szlkLr/eH9apc7CCACeg9a9JcIyKjAH5SqH/a7fpXLa3pgQrNajKnl48dD3NZyhbYuM76HMuCWGcfl3pHQjBI5PU1dbByflyD0qpNkglefasjVETICp4G4HoelG5SAJOPp3pHBLcAqcZxTwu5fm4xyf8AGpLG/Kq4X1wM812mgaQltA4n8vz5QGWQHgjGcKaxvDFuk2sRGX5ljRnwRy3sPfv+FdtdBJsp8pBbPmdMA4IYAeh/nW0FoTJkUWIZyFZihcHOc4buP896ntnL3YKKwQngH0zjIqJ8JCySAAgbpI26NjjcPb+tWbMqt0rEBW3bcZx9T/KqIex1MS77fDEYBrJ1GNgS2MIvT1zV5JxFGQUzznNUsm4SVejZxnrRbUlOyOS1IlU+23eIrCLKiQ9T2PWuA1j4j6bb6hKUi81wNuNpK8V3nxQgI0BLKEsqS5496+XrxTDcypOj+Ypx6c55raNkjOfQ9OsviGDeeatvHH/uk5P1r2H4f+I49eijhifyp4zuAU4LD+tfKcEiou8RFuQOO1eu/ByC7udbtLmDfGEZSc8VcloTG9z69t2M9pEqqTIqhSSOD3Bq9ZWqqwkQL8w+8OopdMhUwJIWB3IBwe9WrSRQHOCACee1YGmhx3xigluvCEttEMyO6gEdvevlq4ALy5yxBKtj1Ga+rfG2oINDkuJzGBzsEnAJ6DNfIviW5eHWpn+6Wb5k/wDrVNTYumyOdU4KbQh53DuOx/xqERAsqsgUP078/wBKmR1kCSREFMZYenrio2AwxLfIRgbOOPpXObWFEZVd6hgx4JHp6j0qnIoMfGUAOT3K+/0q2rnORlgBn/Z59qaSGLP8vK7TnnB98fzoBooSQbJGL8KuRj+7xnIx2qKRihCMQRtyuffkH3rQyUUIindnGCM4HtVeaONvkXoM4Yjgn/GmZ2MqR8HzVUq/c9iKryuHByMep4/Wrc+8FiVIKj5ueo9fcVn3AIchcL6kUAQPCMggnBGab5PufzNSyM2RuMZOO5INN3H/AKY/99GnqB//1tkbmuIBtbnpuH0/l/I0TBZPOZVDNxtYds8Yx36VMkpYBt23JzwM59/5UyVoySScI7Fdx49M4+hwfzqiUcjr2m/ZX8yHmFvx2/8A1qwMEb0I285zXo06o+EICyeSUye5z09xXGa7Yvbzu6DbFu2kAdDjsPTrWE4W1R0QlfcxxjCg8sOp74oYYGDyfWpXj+6OAe5Heq28qxDgbc9qyNTrPAcZbUGeMfOo2ru9x0x7118dtufaJCH5Gc5AJ4OB/nvXL+B0AtLxnzskbaxU/MvHB98E5xW6twd7F/ldn+bafuuOuD3B6/nW0djOW5JdmMxxHywpX5ZB3Bxgj8/8807zUV0kfHzYLHH3WwOlV3VZWeO4fKuehGAGIwD9Ox/Cs1HGzZcZ2lmTPckdQaYWudxaXUF3CURsuBk+9V4mMc7LnaX/AIs9CK5fTprpJTKhbduwT6jFa39rA6qbN40RkCKSx6uf4fwqlfcjlvohni+2jewEkw34bIJbOMdfpXgfjvQ4p9Qe4tWETuoLJ2Y+tfQ17YjU0nWFVynG09BgdK4rXfDqm/td0RiXfsMu375C5OPxIFaRZDXRnhmlaFdvNl/3QBHPrXu/wxt7axaFBhpFIyM/eNZkPh1Rbh7iYyJmNpEC5Zd3Ug9wCR+teheE/Cn2aczLCsflYxk53A45H4U5ajjaJ7Bo04+ydwcZwR1q5bPH5RDYC96wtOkeCyjLsxAIQ5P5ceuKmnuGniVbU7N7YBIyOO1ZsVmc18SL2ya1ZZp0JjyFSNwGBxXzprcMM3mE4khwSFJ5xngg9Rj0r1T4maNLpV79o+f7JcqSW6lXB6Z/UfjXml4wMk54+cgrs5VSOufr+hrOZvBWRzT2j6dM3lr5lszA5zynuaJvlmbDleC27Hv+np+HvWwp2SbSv7rJ+XPPPQe+D3rMvYkC7ShRowd/X5sd/rWLRoU5SSflIDjDNtpiXOPmPUHOM/54qGUNu3q2SUyfb0z7VWSRQScEDdgoTk5NIRd8wIuTzt4BHVc9B7j3pVzsAl+dTyQvUjt9KpGVdoXqRwN3df8AGnzOwIkThwc/NzkDjOPbv7Gglle/bMjW8p2FVLI/19KzyxReAcgYKkYzjvjtVu8lSUkMVUhRtOOG9Oe1UpCkm/eGDL2zz+NMlh55JO0EDsA2MUec3+1/33VZo9+CS2cU3yf96nYR/9fZSTYiQxHOw5Qt2Unj9KS73R3brIm0rh1/iGcf4E81JLbKkJZW3KNwUsc4XPAPp1prvvlUqsYKIduDnevJwf1qyRpiSJsk5Yx5jU8k46f4VXvVLQpKNjiUqJFkPAweCPz/ACNWCipGsy7dsQ39z8vcfnx+NQSKv2Oe3Ukr0SP0TOVwfyH4VLRaZwl/F9mup49uzaxwp/pWdIWO3KnHWuw1WCCdUjuARMrAO6nJwRxn0PQGuWvLdraXEjA5yAezYPWueUbHRGVzqPBZUWM7kZVXJIbovGM+9bc6wxGKNSUiUfMRzx2b3OeD9a57wjuW2uJVGczKuT0xjnNbF0zi3hUM3lLnAbHQ8H+v6VpHYmW46WUMi7mEZOY2RuozVS9Lb4pkyZFKknGD0wCR7460MWZBKoLsQEYnOMj7pNWVgdp0bBJYYHHUdOfypivY6HQNOWa2ABILAk/7OT61lal4Hvt0ElrfxbbZ/NVmT945GSAWzjk98V6L4U08PZgMvygenU1sXmmR+QwfkegqoysZczuea6NqV5NoKHULI2mrSSkSRL8y5LYGGHBGOc0/U/E0dhp0lzqFuEtIGI3TDGSG46/Qn6Cuxs9P3z/MoSMdB3rQv7C2j06YzxI6AZ2soI/Kq0uTdnKeFNR07VZ2TT4YC44dRgkEgN/WuzWyl+0wiYYQkKAB7VyXhTSTB4jN8USMNESIkUADPc4716nZBLhE3LgjB5pysNO5GdKia22FS27rmktbCK3KpHHhB29K1gMCmSkKd46jqPas2O5geLdCttZ0ea1uYwyMOvcH1FfMHi7wte6DqJimVzAf9VPj5ZR6Z7H2r66mCvFhT97msDV9GgvreS3u4Vlt5B8ynt7j0+tTYuMrHx/NgRheNud6Y7/571XMmyRLlgCXXGw859QO+f6Gu4+JXgyfwrqwaLdJY3GWik74HY/7Qzz6jmuE2jYY2YeYuWTuM+g/pUNWNk7mJdo1tM4YEnJ2uvX14qnIVkHyqNm0uGUdD34/p2rZnhWXKFhuYEdeh7fn61g3IeCZsnaRz/kVFgIfOLc7ufZunpmrCSFP9cqk5PIOQKpEjaxQfdHKf3cntUaSGIYYgIT2OcZPUUrEs07hldslA7epGPrxVGR4235CJKc44x78/wBKV7oYDDIABODn9P8ACopwroGXGT19QPX2pksq+aVJ3+YrZ6L0FHnL6zfnRKJFfBUN7hAf50zMn/PMf98LVCP/0NqORIJmjdgUcEK5J2src7T+tRWjopZWKpgBS5O7nOM46kZGM08xoZpE6SBSoZuQCex+lQXjM1yJgESNkBOxM456H2yCfXmrEkOWRzdNbkZyvybj8vPGM/yqsWYNK5gdjFFxg/KRnBHPfr/SrMbh41ZlAeJ9n1HXGPwzVVgsu5UIjyxZWJyvXnkfh9DSGiiyRQyGR4t20LkE/eT+LA78HP4ZrJ1aFCht/wCHeQhAyB3HueMmtuWVTp9tLHtJRwjEN2zkDPpnI/E1nSxpJauIkDMGLIu7p3A+mahq5onYi8LToLG5sLgERbzvbrsz0PuMgVqyb2gjlkKZDbHTPU9D9OoP0rLsp44A5Khre4QKzltu0Hv754/KrG8qyGeVvKZtkjhBkMOenr0GaldjRrqXLKWSedbVgDFPzsPbB+7j2rr7HS/KiHGT3PrXO+FoC2pZ3vIsZLIWUAjtg4r0KBBsUADpQZyep0+jbIrKPoOM1rwwpKhL9/WuWtZSNozworQh1CQXiRFSYyMk1VjNo0XtY4ixj6nktVeZEmgKMAwY459KNTuwkBVTgnvWP/aGyMAcluB/jRewJD7u/gtdRigQAMzYz746V0dtcMl/bRnjd+vFcdPbie7tbgpl0kD/AEFdpavFJEjSD5gcj1FU2g5TakcIuWNZN/eMAvlDLGlneSVyGysfb3qpPn7ydR096QEttfjzTC5wyfLWqirJHkHJrFtGEjbpIhnPWtyJgUAAApAec/G7Txc+B7uQorG1ZZ8nqoB5IP0r5bvgDJvQhWUNuA/Tj0Nfa+u20d7Y3FtKqvHKjRsrDIIIxXxl4ks203Vru1GVmhlKMD09MVLRtB6GDLKPK+dQpxnk4A4+7n096r3KiZPLmAXqQSuWx2x61cvB5kKhsbkOGXjLcdfrVS4ixGisVIJOx+cN7E9qgs5zUEaHaHGM8q6nis5rgglW+YeoGOa6O5TzI3WWIqQTkAdCB+hx+dc1e25Vxn7rcrTViJEsbkmMt3zjHPNSyu5XHBbGCPx//XVGElQN5wwIG48gZ7/hU8UgkJGN7YK7lPJA9KGibk8UihNrZO3jOCad5ieh/wC+TVZpXQ45b3H9fem/aH9H/WlYLn//0dNJ088xoiIkknILEq3H+A7VVEDyozQqdtvkMGPLKJPX6d6tXUYfE8K7W4BGeiMMZ/A8fjSCfNos+SGhYwuwBG1SMrn19D9a0ZKZL9oBaRoliZZcuhT+8vI//XVGWRY3ETj5IySobjCE5B+vanXSyQyxKCrbc+UQeSmMgH8SfzqO+DSeWHYNIWCqeuVHP9f0qCkULiTy4p87NgO51HAHcnB/PP1qrzFdKjyOFZcqzkYJ/p61bt2WSZllG9JA6SoQe3Q49CKzLk+RFLGFwYMQbmOcjJAb9QKk0RDe4yofG5AVKg9Mnj+fWoobktZhA5LLMyE9flIIwfoehqG83LcFo9oVEyDzng8jB9jVQ3LW7vJ8wRuSpPJHFc97TNkrxPTfCS4gMx+V5CN34V3NseAOBXBeFmC6XCYyNrEsMe5rsLGbOAa2Rzy3Olt4gUB7fzqfYyndjGP1pmltvUVoTjbHnbmqJTMi+Uy5JbnGKoRptYAgE9BVu8kIPpUESsxHSpNDa06FZCrHnFbYtshSxxisW1fFuscZKN1yBmughkWSPJAzQTcZJ0ANVS4yVHSrUxXsOcVlyXHkvgincbWhdi+9zitCFgB61hpdofxq5BcPJgRKTmmQ2Wbs/IfWvkv4xWjWnjW+dfmjnbzOD16dPfj8q+qtRkaKzlaTAwpPJr498c3c15rl5K7h2MhHB4Azx/kUmXA5yfMiYRxlcuOc7fXNMkAZSEDlM7XiI+4fUf56dajDsjjblG6FsdSPWllHmOGjX51+Yr1VgeOR3H+eKg1K1wzRyLHIS3m8cc5UdMHsc/4Vj3yh2KSgbcHacc5Fb9x5LLujO5MgkDkx+x9v/wBVZ93a+ZCFYjcQGBPp2xjpQJnJSORmNuvf/wDXUMUjRtlTzV++szGFDMDLkDB4P41mkEHB4NWrGUrmnDcFoxtIXHBz60/zn/vLWRRRyoVz/9LYZIftkieZtUuX8tjjK5Bzn0HIqqSx+220YbcreaF2g5VXzjdU0t39qFvM6IZGGzKfwA5GR3qGeTbPCyo+GUps2An5RySPbj+taEEjlGsUljZ12L5ahlGeOo/A1SnkBtYpolQQIzKyklSuQCp/nUMNztiuY1cZGJ14yp2nkEDsc9aYknnJNBEC0JJZR0JH19Bkj61LKRWuZERwYZDlZcglsA5HTPbg9apamxR52iQyJNtUrnhX65H8/wA6kkHl2/l4BIwisfbkZHbiqcgC2aiJ1di2/buwQR0HH0P51DNEZ090rxMXbAU4xtI4wf8AOaz7oEx7eMklgxbr7fiKvSndIjSAhHG0jHXJwf1ArIbcqnyySc9x0IJ6Vz1VZ3OinqrHqXga5jutLhERyAuAD1rtLNJFYcEV4/8ADrUTDqDxlsA/Mo7cnk17FpMY8xiX3yMck+g7CtYao56iszdtLnyUDMce2adeaySMLwv1qNoo5bZiRgjPFYFwqJJwTkjOM1ozOJee8dkdlwT1AJq7YTs8alxtbHIzmsq2wy7TzWhbRkNwcD0qDW5vWVxmRcmtlZ0hXLvtz3rlkYLJHnP3h+db0UiSnblSyHkHmqsQae7emetY8oMt3JHIRxggCtlE+QcYqrdGO13TOAMDqewosNspN5UUgj6t3zV+PUbe3lWB2VXwMVxul6suoahI6Hcu44/OtDxFLasiF0b7Ttyjqvb/AD2q0tbGbJtc1XzrS+BZAqKwWQHjp3FfJ2vSGWWZ2U7t33uhYZ5x/n0NfSOrXTPo1zHJ5eTEcqMnBxXzZqcaMXKHPPBXqRnkY7EenpUSNaexztwcygLjGT8xOfb86sIWXYQSGjzg54bjpj9cU+4QLI/l5Vn5Kqc7Tjj/ABqDAk4JZHXC59fcVmzUiMgDJJHM3mfeaMc564yafK8UypyoGBhWzwPXH+fWkR1LF0fbOpJfJ6544z06CiU/Z5mnWNxHg5jPPIPIP59PzoEzMv7YmAO4bzNpX689Pr71zlxGwZhw2D174rsjKHDIpDx424bsf6D09657VrRo0V1yF6hj/EPWmiJIxKKD1orQzP/Tvacpez8wZVCflEi4K84z+B4/GgCdoZI4laN495JduTjGRn6kgj3ohu4oZrR8AC4XB25JII6Y7c0pkka6ebkNIxMwLDG4YGQPw/SrIKrxfZ7uxk8lWaWQ2vTHBTdx/jVWAMs6R4fyimAc4+bPp74zUlyFubW6SCTErxll9mTG05HGfaqkrysr3DlkZ1DljzhgMbvxGD7UMor6kZEj3SfM4XMjqucP0PHU4BBrIAjeJnkXCjEoG37qk85x3yDWnNKwslmcMJkjMZKjhjnOf581kXieUSweQRSDHuMgYHHUc1DLiU7xTtM0QMhERPJPGPU9jg8fSsm/cbz2bg/KOBx79+a0Z7wSecHULLGNpXGNwzjbj6Y5rAkmLlnZiMMQwc5+lY1djam9S5plwbXV4mjYqhfGDwff9K9jttcmj+xxRSBGZxk4ySK+fzcPBcM6tnDBlA717F4dnN3pNtcbjEyLuJOCcEetOi+hNZdT1nTp499yvnmR5GztP8OAOK5bxFe/Y9YtTuwjZU/lVjQy15KJoGVIwNvPVvWsPx1BLLp8k6AiaElse1bPexklpc6qyPm3CyI3yleR610FqoYCuC8GXpvNCtZ1PJXafqK7bTZm8tWfHPBIpWEyxMrLKp9DnIra06WNJC+Vy3UjmsmRwwCk4ycVfg2AcgbQelFgudNCylQe1cT8UNTlt/D0i2ILTz/u48d2Jx+nJ/Cuhsb1Z4i44XoPpXG+PZxPe6VapxEGMr4/ugYA/M00IyPDlqdIsbdZnZjwGI65rqbe+B1KGKVkkhlGAG6qfWsLJkn2pkqFJHHB6VFp9vNJPiRSThjGc55x60oattlTVkkW/iBLb2WjXPlOsR53yYx1Hb3r5tuVlWdo48CNmJXI+YHHUfyPNev/ABYuG+yrbO4ZY1GecjcPX1+teOXDIzPKq7gv8LNy+cDHsOOtTIuCKFxH5riVNw2rymSVGDyQe/X8Kq3ELMGkRggI+Ug9uwz71duW3b5ImOH/AI8EbT746DPBFVBG0jCNuCCSQpGf96oKI4pyz52qZU4bPByOCMe9LKSYiy4c4KeW3OfbA6/1FMc4hUpJvTaNpPD5znceOuO1PUsJnmhil8tSSycEuh7g9iP60AUGjaKXaCD2bb0HufaoriYyWpjnUODwB3Oex/Srlwjsd+wLESxJxjPrj3qC6jRMQ7fmjPyuDjIxwc+lUScncQGKUryR2PrUe0+ldY0KTBXeKZ8j70YABpv2SL/n3uv0q7mdj//UdfwSKlwIieWcrswShB4+gxmpW/eXLPEoWPCyg9yvADfn+dSpEFmeGNpIlkRSgIyc8g/UDvWatzLFp8ckMXmyWw2uAw+7k5Hv2x71ZAWTPbavc2srKhlHDL0bPBX2/wAahWXyofKEPyECM7jwQpOBj3GDRrTRRyRzfIjOirIEJJUHvn1qssgW7UOSFlGe/wArkccn7vANDKWpHESkD7xsJJwvvzj8Kw1+awXy5csIwquOd7Dg5HbGKuyORfKm9mDDJZgQFJIx/L9aqXDyDfBGoMal2GR1QnOAOv3hWbLRkySKFuUaMhyMEE9SRj+f86xdXZYVkjB4BDZ9Afatq/iBJfcCowgYjAbpyf8APSsTVG3IwCfKBtwPmbr6/XpWc9jSG5jTSF2QZGCuQfT0ruPBV4Lqxa3muGWIEqVzzj/CvPVfAAA4X5hzn8Pwrb8J3zW+qwKCoVm5/PrUU3Zmk1dHtnht2hsjIPOWON/LTJ557n616Ra6bb3ekoH+YyqW+bvn1rz/AE65aK1eIRM4Y8EDOK77wrJIyoZEbByTnt2ArpbT1OXVaGFpGj/2Jc3VggxA5MkI/u56j862dNlZEEUnDHP5ir2tWzyQJcgfvo8kgdcVl2cnnYkBHzfr7imJs1HlQn5jgg5H1xVqxn8yM7j1yKw7rCyeacdDjnvSrcsiAo2GOByaLCudbauixMFIx0AFcn4hcPr8aLghIOn41bt7nyIWLnavauRN9Lf6vNfIPkDeSoz0Ve/50dATOr0bzEkhbb+724wf8/5xXQGaK2tSqQ7H5wAOhrD0dSSF7YJwTxVm7vQIGiUF3PGQOlQ9Cr3PN/iyp+yRTRqpI4IK54PpXj4ZZVIDb2JGOxIGcrz06V6/8WgzaHbyqSMS9uvTt/OvGC7wyFCFEe5nkBHDHv7jrSZpHYluHTykmDNtIKscZxxnk+2PxrOlVS5Iy2DuBHJ46irZkYXEyhQyhQd3UkeuPbn8qiZAchVAQcBVJyV9R9M8VAytIqSkgkjKsZIxzuXuV9O3SmDiNCmTj5VKtn/JFTSo8PmKwYtHjbtGS30PrUabgciNQECqwLbXYDONuO1MAmjUsjuFMRJDAHJB7MPqexqsmHKqw3OpI3KeGGPX+VTxuZYGCqSrcOd2N3ufQ1DGPObzeOMOseMYx2x7e/4VSJZXlHmENGrbMDaAcbfY575zTPKb/nm//fQqw0EkmCvlHAwQSQQfTjr9aT7JL/dh/wC+moEf/9V+rXIW3iuI4PkidY5SDuYK/XGPQkVmxQJbC8tottsu4x+UF4CkZDAdSAcD8afI32nTZFeRTNGjAR4zjnAA9e3SpBseG1aZd9zsxKytk9hgnt9a1IKlvJI9neJH5anYpBCk7iP/AKxGKz2lcQF9mfLbs/OcYOfwz1rXVo3nWMSL5K/w4x1yOnsOOfWsYDE08TxvuXdIMsCT/DjH4ZGaljTEupH3QyoiTQyhFdS2Pmx29iMfjVTVLp3KvIyfvFMEhC/d9vr09qRIIjMjkxl1K4XcRjJO7B9sAg/hUM0ocNDOyScecVAIPzE8fljk1DKRlXbPKqq+1nHUk434Hyk/WsO+uNzPHHtDuN4RhwPr+BrTnPJjVWZ1/duR/EMf0zXOXgZ5k/ehsqFOOAQO38/yFRJXNIszjjePLb7xAUHtxU2kH/iZ2qnCkzIpbP8AtDNQTBhu8vG9GyCOhFRwyGKdZUK71kyMjuOQf5VlFamzZ9M6XcfZpUP8LcGu60C/Vup56jivLtJvFv8ARLW8jG7dGrkH1xXYaJcB5U+zFlO0ZDDitkcskdyxDOxyTuGK5G+T+xdWKfN9ll+cAfwHvj/Cumtnfy+gVs9a57xwhntUnif94p456itETuXcW9zDlSrg9s1nQRNHdnjMQOQSa4zRfEZkla3kypQ4IP8AjXVrfRLbxSTNmRsgDPJwaZNmTeILsQWzyM2FVSQormvCtx+5Unnc3I9yeatatK92hVsBT2Fc0rTWk6SxMFhJzw3J9PwpNlqJ6/prQwnkEZ7U3Ur1lSQxAEYOMH9awLTWlkixkE8YI9Krx3Et68kok2RjO5ug47VMgXdnPfFi9DaNYW8LR+aZRIQ2TgAdfzryW52TzyRFNr5BVtx6ZHygfnXQeNtV+2eIWyWMUQ2pjJAx15Hf61zsrI7hol4Xp33HqOf6++KlmkdiNchpFCOYwNqknlT6HuBzj8ajeVonuA0hKSMDjbgcdh3xx19aV3uWlVhlZy+LkL09VwegHNMHly2zCNlAJ39MnJ4yCf4f/wBdSUEhcuUCvv3HapXBcYyVHv1qskK4435T7jEYPPY+g4/SnDO1jJJtIbJZm3FD2I9AP602SSURfOEEvTZjhhzg++aYmQkCOO2cqxjILMGbAUnkM3cHrxTZiH8qRRKJCBv28FgPukD19vzq0uLlWjHVCX3Nxt45IPrg85qusw3JDDv8wYCyKMDn0xz+J9KCRC9szN57SRSA4Kgnj8uPejNl/wA95fzahZoYNyGd4GBOQqAhz3bPvTvtkH/P/J/36FMLH//Wq2trKl0Y3khjZBuWJVA3sPpnOQAfzrK0m5jW8uopbcqszsTvf5Rxz9Rnt610M4+2X1vFbOqA27hT/HuBOCAPu8ZFcrcymPUhcTTtLHMRsRh/cyu7/Z5x9a0M0XobxXkg35jmbduDNyGz+vTIqO7mQ3iwQ+ZvkB3SOMnIIOPxBFLMI4wTOsjeXtdpEGNjHjv1J7+grM1cOYdieZl0wsg53c54/DGTSKIYZvKuwAokzk+WRwhPG0/kf8Kr3jfZkaVFQpFIEc+gY9x3x+lTS5iSW9ib91CBIzMAccZJJ9qzrm5W4XymDAyoRnJzux1J+mOfwqWUjLv32XNzbgNuYZQkdl4OffHasC7/AHUiuMKjJkA/hxkdK2b6VFjUFmU8Bxxkf7RH61jSlOYhnzFIIBHT3Hp/9apZSZRkysjfL93GOOSMVVbkbUJ4xg/pV8KGEcgKtsGCSMhyen/66hn2ZUgg7gdpxjPNYvRmid0erfCu887w8YGf51kkAz6ZzivRfDOohcwyna6cc968g+FzxoTEG+67cnjORmvWIdKF3AJIH8uUDIYevvWy1MpaHY6dflmKyuCpUgY9R/8ArrmvEuotNctb2xLSDgKD0xWBNqtxa2/7+PyZ4Djk4D8f/Wrl5PGcT3l5Ku1SMiOTHfHP6iqt3J22LC3P2V3e8jW3kychjinDXvPeNFJKoDj6ZritQndybi6aQsBufdnBOOAKlkvhazQzncsRjGSB1Pp+VJsu56ja3cl1EP3Z6cEng1qaVpX2hGE6g7hjAGBiuV8MazHfxnyxt4G3ntXoekyKEBJ59aZLkzKs/Dcttch5LrFquTtGQT9apeLvEUNhbC1tehG3K1q+OL+W00yR7Y5kKEqCcA4rxe8kkun82eZXcH52blRxwPc03oTHUoXTTXX2hd6PMhBQ5+aTnv8AWlSRVwGMocbVUA8/U/n0FBlLQxpF5jSIAIvl6nq2RSTjKrcW7uWJBlKrwgxnJHQHIwayZsKA0d8u7aGYheM4PHDdMEj370kpiieObarzhvLJGAwXqMAdf6c0x5FEcazIhbBYMxOSCehA+7+NJgRs+yMo2Spyeq4wDj9KQBcRbArhN7D94Ac8n/PP51SvMyIpJBkUhUG09MZIxj8quiL5IljITYdzB1+YHngZ6AjoajVxgyeaxJ+6VbOxvp370yWRI8KqWkKkDEm4qByOoI6gjoaCrSH918oJJUEHII5G4D/JzVeQxrHmI7UYlpFzu2kn72T7Zz9asyAQW/nLuXBxIwY4wOAfQ+lAFYy2ZSPzYWdto9Bj296b5mn/APPq/wD30Ku+TCVUuttnHRx0+nPTv+NHkW/92y/L/wCvTsB//9elqE81lLLJGCJoY2MXUjPB+p757c1l6jC5njTY0jkLLCufl2k/Mo9OOn1rQvHS6CTyQuW+0mFyDnhl/h9+gPas1pDIlncRxhfKdrKUjncCdoP4Y6VqZosZM8T2qSpMhzHuf5QCRknd3OCo/Csnc0PlJ5zO6yeWoIIOAcdOxOTUsJRlICLkDOI8hQOAPzK/zrIubn7RO6gXGCWUE8c55PHX+lIZZuGa1imidV3RHchkA3DIPPPXkVj32ZbeSKJ8MsIdGA7/AN32HFJP9qhaDCrLt/dK7ZyCCc5JPWq0lwVeKdVZR0fcepY8/h7VLGZd3KHh+9mNkDL2yD3JqjCplZZMAZyCSvJIxjPp9KkvEMeEeTcqT7Sq/wB1uhH0zVW+OI3KOFBy6r1x259wR+tQy0TmJAZmQsoJPAAwOec/0qjdzZRh0IyOR+XNWgpfzHw3zJ849Scc/hWddTGRwwBXcg4Pt3/WoaLTO0+Fx/064JJKnC5PPPf9MV7ZpU5hhKBtw9a8i+GunyxweYw5c5x7dv6V6ZaRvbps3lifmJNaRMp7nO/FW+ddMhWIHM0vlsfQY615SQdzRYO0ccH73oM16V8TrV7rSIpM4WOUbuccEYry0sfMPmEb9vAx3B4+tTUvcumtDet7hLq3dZPvoioYwc9eB14yKVdqhoHYqSNwU8bWHb3HesvTSr3EayAv1y2BkMeg9Pyq/eDCPMrYVto3vy2d3X8OBUp3RbRf8KXzwas0C8IRkH0weRXselX6lBz2HFeEaPc7L9mZ8vz6duwr0/Rp5Vgh2HG5vmJq0yGrnT+MSLzQHwP3i8ocj0rx1SSsSxuPNQlRg8cdDk+1ewSIl5YtDKDscbeO1eXa3bPY30lvKv75W3Jhck++enSnJ3FDQyJXMPzwPhvvB1JGWzwT9OakBCF5YSYoy21huO1m6n255/nUV06G2KMWdlPHPzEkc7f51ExlW3hiIVjt4Ycqx+vU8Cs2aE07J9pkW1KJbSBfLxn5SOfmJ9T2p0b75t43LJgglucDPIx29PXmoVDi2ghmiKlWZkZ27H+friqzlhL+/jkJdvukAfMOjccdPehCLkjMxDIS0TgDnB+bsCPpio42YySkEjIPQDPXgjsB2oidnKy28e5wGVxwpcduT9Cc1HNJjaPMUshyGA+Zhj7o9896olk0UcaTSlGKu2C0bHPJwMAdMe9RQrsllheML5RBAYfe5+6M+nX3pAY7kxybJN+CfmwF+gHtUlwkUbmTAOzHDccEdvx6fjQAkX2iNMQmEL1w74IP5U/fe+tt/wB/D/hT45l2A4ijHYbhjFO85P78X/fQpAf/0OP/ALQuJGS6nSNDPG0Mg3EiNhg5UDjI9abMjfY3UyKRmOVhuILbT8zYPA65/GmLGzC3iiyNzNHcBgVIGM/UnoO3eltpo5ZPLllYEQsHBB2vjqPyHGK0MyCe8CWtxcW7BZIAcqTnocjHoQD16c1Q3iaTLNEJUYg8FcZG4/j0q1MDbwyLE8LZ25VPmcqe7H2P9az7xpppGlBVHjkSQucDKhcALigaK9xIRaLvw6m5VuGO8YxxnvVGebzYpztIDt8xLDAGScipdTtw8zeYzgySbhuOCflyDx0zzx7VhQyLLGgcZlYfPsPJKnnjsCBipZSH3Vwk94+yKRIwo5PY4wf5Cs6MqsARgG3A9OOOhJPfjn61ZuXLK7JtypCAk+/p9O9VVUiQRAfN5ZUDOc5PH51BRbWUQiInJJx94cEdCD+HNUVi82+WBSeHwwxxtzn+VWJnEkSq5GyMYySO9VxK51GBwcM6jdg+9FgvY9e8P3C20UESKAWxyK62F/3pDPyR09K880q6jFxaR7uBlmPsB1/OurjmiENxdbiNuAc+gFWkSzI8d3yTaDcRocFZRyR1A5OPfGa8uZ3SZXVSSuMMRyT6flXY+O9QV2gtrYkL/EF+nWuSkJWRpF8tE2nDMehGeg9+KxqvWxpTWg5WZXU8fIMAggHk9B+OK0NOuGks5FYRmQExsqnJAPJbP1rB3lEQFcHbsGR0GfT3qa2uJre4EisVXo68cg9amJbLjSi2uD5Z3Fm4yPzr0vw7eiS2g6EgA8eteaa+qukbWysYUUFnPcn7pHqDmuj8IXCpauJT90YIz09q0RDPW9LuN9oJenPftWB8SoY5bRLxUBkhwG5xxnPPtVfQrq4eK4UufLUkf4Gk8QXJ/sImVsyMuDgZ4BqiepxEbGB0QM4aQFMk5OT0I9AKqxrI8axmVXIDCNgcPnpyenPpU0uZhvdmIjDHzGXnJ44A/Dk1CLlDNJKIj5WfKPmc4HTI7cVmyyF4laAbSY2UhzyWYY+U59MUjhhE26XdufDIOxA6g/lU9zGkDOh3MxOFyeWY/wAXp0qCdRHcKIgpU/eGcDHr64/CgTHzTzRujvxxtCsQd3QkAd+lTrGsNwJoNzCXjYmAyDGTk+vNQTKVvokk2+Zjewzk4OcfTp2p1hMsbSq6ICMMSeEJP09RwfpTRLGXTuy3JMYldTlTuIAJA5Bxzx60oKwApNuLScFnU/KcdMenSrtwrSndLtiiyw8sZXkY+bj0HaqaSPIZFaXZMzjl+uOn6imBYltoC5DTS5X5cIh2j2FN+yW//Pa4/wC+DVfzhF8rxrJ6ZY/KPSk+1p/z7J+dAz//0eIs7sPE1yxkZfPLRqMlgCSp5/8AZj2qNWlhvFElujrG7wIuc/Mw35H60ac6R200AEgdGYjzBkHAyFx7AD8ahvWEkMV0hybiFZsrASwbg9c4B7fStSBodFddqlMkRsH55x/I8Z+lQ6hMkSoFDvb3afcIH3gMcY6DAqzeS+Zps86yKEJWUYGFPcjP1zWLfxqmnSFuEiYTKH+XdxnPHUc0gG3W8Rx4PmPEQZQrg5AO0En1ya5i8jeOSTzEJQMGC7sYyfu/yrVubiNvkHmLBJ+7YFQvvj3zmsaQ7IFEo2oG37Qc7sr0PvUspEU8QQzxh1McijaoJPP/AOuoyY+GjG5w2w+rbe49hTppSDCxyE3CNsN97FL5QS4nTaEymVOMYz0+ueagoLeXchKLzMCWbbnYCew74NE6swdmj/iBLnqO3PpUaJICqSlcn94oHU5PT8OKuTSATKy7t8p6Y4IA+YCgRqeHL82xljvPvqAFz6f/AF81t6hrrf2XdQcHzFbODx0ycGuTUNtESpgEAJz94Y9TUDFliClo/M7Acge2aTm1oUop6k15dTXUhLMxYYwAeDx/niq6E+cnlklj1YdARxgU0bgRLCXQEABcZz789KXAAM3IyclupPHH+NZt3NELJtciY4EmRuHrg/zoz8zjP8W0DOMD3+vSmXCl4CWRdjMzADjB9fekZS53s+GztyePcHikM07KR5bV4Pm3kgqM/eHQjnsMGp7cPZtiNzLCw529gRwff0rMsZ3jmU5XeOCzDOcnBx+Ga3YiyvGJH2h28vjrtBJBFaRZDRu6LqrSxsFY7jIhbtxgVL4kZzYSRiRmU7juXIOM9B3rmoN9soeMDLyY2pySBnr6DpVpr2WQrIHKggqrnoCSRnn/ADitHIztqM+0qdNMRcfNjzNmV3MD1+mOKJGeG4iRW3KQyqvGAcjn0xUeRGUdspBIhjVn+cj1P4mpsqsO12UFMqTt2gZ7jH5/jWZZG9r9oQxxDdKp3KxfhYx0P1zUfm7pwZN7MPkdcbA3oRnk+uaeMmZJVffPC2xUZtu5O5PtRIFiuknCqSVbqS2Rnjn0FMGRIeGk+0J5QBVmZtzH0x6dcU6yieW6i2HayN5bKgyoXGefbNMtVR7aTaqJchvNQspIY4yc1JHtaOCba6x/e2s2N+SeDjvn1oETWbM7hnkJtSXVzt6jPT86a7Ml08YOWwCCB8ysAfyB7UvlLIA0cu5wSyxrwgcDO0n6elOsGNxAJCpVfm2ncCRnkr/vDFAFT7WqvIzMWkdt0hPdun9BR9uX/Iq2b2GABCrqcZIBXqfwpP7Th/2/zX/CgNT/0uHhtoYbvU1jmcqr70hXO7kc+uRVCQMNHMSnKrcKu4HB2sRnIHfGRTkuxFqMdxYo6t5Yi6bQecFR69Cc1XiuHubW9tVXZHboSsifKHYc5Leozn8K1JRM8MUv2qJWZl8xljJOB93GAv0rNtD5lvG7ts89Dx95iF4xnt1zVuJ44bedh5bSCNHDucA/7f8AnrWWu55opIMxCFsb24D7up21NwMmS5ZIpc3A8xWAchOdwyOp4Pasq5OxmgTCwyLlmAw2fr6mtPUsyFgypyo+deCG6Bj+GKyHQqqvMAzONwO3OSTjd+IqWMnhRpoZklX5/vIi8dOlQ3DOskc+CTj94u7oPrTIfMbBlYjByH3YGO+adMyOk0KgiMKCvHQdyx9qkZJdFBNHI0jNIGxt3AbVI9v50+MsYp1i+bywGDvxgjrx71BMWubdJLeGNRgqcnkYGPxqdZSl3CoPyHjp8pBHP1JNMZJ5nmQQFWVir546AEYz6+tQ3LMl1Lncythsk9u54oUeUJ4nCFgCoOOP7w6fXmkD5iQAAqUOVA5x6moktCojXyJTHvbbyFwOmeeKkmXcknl+YQPuqoHHT/69Q8ZG0g7V3ZA6j059qW2kEIBkOVAyuT+fSs2WOZwUTaNrLgNnnjGajeQefEyjh1AK5xSxAEFM8qeOOnPGTTHOLgfdKEc552joDmgCYKRcqpJ/u4GCT15rVtZJZ4I13/MIyjMFGMA84PsKx7cCJjGjLuGW+XnPt+lXLa4dUjhOAQBt28AZ6j8qpOwM2YJIyrGBFeNztXH8IH3Rn65NWXMiFYj+8VlCu3BXeBkgCqVozqrxh3KFt6yDuMdAPzpxk811aWNsn5imdu0dNxPqeP1qmQLkSiVpMRRFshzyQRwc479h9KjnchEWGONoUYlw5wufx68H86k/dm3KZDLK+0443ADg59BSxfOHG/OTyDwjAfwr684oAlL7sTMqusZ2gOODkfxDoSMYFQqY2eKNhtjYkDLYCSf3cdgaUEs0ilSXRmOclhkYyAOnekkch7dV558zJTqe7e2OPypgRRiMXKyGR1i3ndk5O4cZX2B/nVkKY1IAMQlQ4Rm6vnn8zzVeRhd24nlJd428mYspBbuCQOmev402CIeTsuQzRsQFYnqP4ST2xQBbhP2Vx5h3A8uysCFBPJHvTpo5YLxYYxtSdvmLY5bsQfQgVA8aMYvtIZWEZQ7DgbR1YL79T3qaG4gkRVSFRMqsAX4ynbJ/lSAbPBhx80kZxynHyn06VF5X/TaT9P8ACrMN9BbpskBkkySzYHJp/wDalt/zyP5CncD/2Q==",
                "title": "Image title"
            },
            "note": [
                {
                    "text": "Note #1"
                },
                {
                    "text": "Note #2"
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Media/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Media/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Media",
            "id": "729e5242-bad6-4bd7-905d-9716ae262971",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "status": "completed",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "operator": {
                "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
            },
            "content": {
                "contentType": "image/jpeg",
                "url": "https://fumage-example.canvasmedical.com/Media/729e5242-bad6-4bd7-905d-9716ae262971/files/content",
                "title": "Image title"
            },
            "note": [
                {
                    "text": "Note #1"
                },
                {
                    "text": "Note #2"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Media resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Media?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Media?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Media?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Media?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Media?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Media",
                        "id": "729e5242-bad6-4bd7-905d-9716ae262971",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                                "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                            }
                        ],
                        "status": "completed",
                        "subject": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                            "type": "Patient"
                        },
                        "encounter": {
                            "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
                        },
                        "operator": {
                            "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
                        },
                        "content": {
                            "contentType": "image/jpeg",
                            "url": "https://fumage-example.canvasmedical.com/Media/729e5242-bad6-4bd7-905d-9716ae262971/files/content",
                            "title": "Image title"
                        },
                        "note": [
                            {
                                "text": "Note #1"
                            },
                            {
                                "text": "Note #2"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/media/


----- BEGIN PAGE https://docs.canvasmedical.com/api/medication/
### 
This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medication.html>  
Best practice is to utilize this endpoint to find codings to feed the [Medication Statement Create/Update](/api/medicationstatement/#create). These medications come directly from our integration with FDB.
### Endpoints
get /Medication/{id} get /Medication
get
/Medication/{id}
#### Medication read
Read a Medication resource.
### Path Parameters
id required
string 
The unique identifier for the Medication   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Medication.
text 
json 
Text summary of the Medication, for human interpretation.
Click to view child attributes
status 
All medications returned from this endpoint will show a status of `generated` since this resource is generated from FDB.
div 
Limited xhtml content that contains the human readable text of the Medication.
code 
json 
Codes that identify this medication.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the medication.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Medication
#### Medication search
Search for Medication resources.
### Query Parameters
**A Medication Search requires either a code or _text search parameter to perform.**
_text 
string 
Performs a case insensitive partial search on the narrative of the Medication.
code 
System url and code that identifies the medication formatted like   
`system_url|code`.  
Currently a search for an RxNorm code will return both branded and generic medications associated with the RxNorm code regardless of whether the RxNorm code is branded or generic.  
For example, a search for the RxNorm code that represents the branded version of metformin will return a search bundle that contains at least two Medication resources – one for the branded version and one for the generic version. The branded and generic Medication resources in the search bundle can be differentiated by the presence or absence of the RxNorm code for the branded version in the list of codings.
**Search Values Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm|code
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Medication.
text 
json 
Text summary of the Medication, for human interpretation.
Click to view child attributes
status 
All medications returned from this endpoint will show a status of `generated` since this resource is generated from FDB.
div 
Limited xhtml content that contains the human readable text of the Medication.
code 
json 
Codes that identify this medication.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the medication.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Medication/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Medication/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Medication",
            "id": "fdb-449732",
            "text": {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Tylenol PM Extra Strength 25 mg-500 mg tablet</div>"
            },
            "code": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "449732",
                        "display": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
                    },
                    {
                        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                        "code": "1092189",
                        "display": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
                    },
                    {
                        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                        "code": "1092378",
                        "display": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
                    }
                ],
                "text": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
            }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Medication resource 'fdb-399234'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Medication?code=http://www.nlm.nih.gov/research/umls/rxnorm|1092189&_text=tylenol' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Medication?code=http://www.nlm.nih.gov/research/umls/rxnorm|1092189&_text=tylenol"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Medication?code=http://www.nlm.nih.gov/research/umls/rxnorm|1092189&_text=tylenol&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Medication?code=http://www.nlm.nih.gov/research/umls/rxnorm|1092189&_text=tylenol&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Medication?code=http://www.nlm.nih.gov/research/umls/rxnorm|1092189&_text=tylenol&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Medication",
                        "id": "fdb-449732",
                        "text": {
                            "status": "generated",
                            "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Tylenol PM Extra Strength 25 mg-500 mg tablet</div>"
                        },
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.fdbhealth.com/",
                                    "code": "449732",
                                    "display": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
                                },
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "1092189",
                                    "display": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
                                },
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "1092378",
                                    "display": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
                                }
                            ],
                            "text": "Tylenol PM Extra Strength 25 mg-500 mg tablet"
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/medication/


----- BEGIN PAGE https://docs.canvasmedical.com/api/medicationdispense/
### 
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationdispense.html>  
### Endpoints
get /MedicationDispense/{id} get /MedicationDispense
get
/MedicationDispense/{id}
#### MedicationDispense read
Read a MedicationDispense resource.
### Path Parameters
id required
string 
The unique identifier for the MedicationDispense   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the MedicationDispense.
status 
string 
A code specifying the state of the dispense event.
**Value Options Supported:**
  - completed 
  - entered-in-error 
  - stopped 
medicationCodeableConcept 
json 
Identifies the medication that was dispensed. This is simply an attribute carrying a code that identifies the medication from a known list of medications.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
subject 
json 
Who the dispense is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
performer 
array[json] 
Indicates who performed the dispense.
Click to view child attributes
actor 
json 
The individual who performed the dispense.
Click to view child attributes
reference 
string 
The reference string of the performer in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
authorizingPrescription 
array[json] 
Indicates the medication order that is being dispensed against.
Click to view child attributes
reference 
string 
The reference string of the MedicationRequest in the format of `"MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e"`.
type 
string 
Type the reference refers to (e.g. "MedicationRequest").
type 
json 
Indicates the type of dispensing event that is being performed.
Click to view child attributes
text 
string 
Plain text representation of the concept
quantity 
json 
The amount of medication that has been dispensed.
Click to view child attributes
value 
decimal 
Numerical value of the quantity.
whenHandedOver 
datetime 
When the medication was handed over to the patient.
dosageInstruction 
array[json] 
Indicates how the medication is to be used by the patient.
Click to view child attributes
text 
string 
Free text dosage instructions. In Canvas this text comes from the `SIG` or `DIRECTIONS` field on the associated command.
timing 
json 
When medication should be administered.
Click to view child attributes
event 
array[string] 
Identifies the specific times when the medication should be administered.
doseAndRate 
array[json] 
Amount of medication administered.
Click to view child attributes
doseQuantity 
json 
Amount of medication per dose.
Click to view child attributes
value 
decimal 
Numerical value
unit 
string 
Unit representation.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/MedicationDispense
#### MedicationDispense search
Search for MedicationDispense resources.
### Query Parameters
****
_id 
string 
The identifier of the MedicationDispense.
patient 
string 
The patient reference associated with the MedicationDispense in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
_revinclude 
string 
Standard FHIR `_revinclude` parameter.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the MedicationDispense.
status 
string 
A code specifying the state of the dispense event.
**Value Options Supported:**
  - completed 
  - entered-in-error 
  - stopped 
medicationCodeableConcept 
json 
Identifies the medication that was dispensed. This is simply an attribute carrying a code that identifies the medication from a known list of medications.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
subject 
json 
Who the dispense is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
performer 
array[json] 
Indicates who performed the dispense.
Click to view child attributes
actor 
json 
The individual who performed the dispense.
Click to view child attributes
reference 
string 
The reference string of the performer in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
authorizingPrescription 
array[json] 
Indicates the medication order that is being dispensed against.
Click to view child attributes
reference 
string 
The reference string of the MedicationRequest in the format of `"MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e"`.
type 
string 
Type the reference refers to (e.g. "MedicationRequest").
type 
json 
Indicates the type of dispensing event that is being performed.
Click to view child attributes
text 
string 
Plain text representation of the concept
quantity 
json 
The amount of medication that has been dispensed.
Click to view child attributes
value 
decimal 
Numerical value of the quantity.
whenHandedOver 
datetime 
When the medication was handed over to the patient.
dosageInstruction 
array[json] 
Indicates how the medication is to be used by the patient.
Click to view child attributes
text 
string 
Free text dosage instructions. In Canvas this text comes from the `SIG` or `DIRECTIONS` field on the associated command.
timing 
json 
When medication should be administered.
Click to view child attributes
event 
array[string] 
Identifies the specific times when the medication should be administered.
doseAndRate 
array[json] 
Amount of medication administered.
Click to view child attributes
doseQuantity 
json 
Amount of medication per dose.
Click to view child attributes
value 
decimal 
Numerical value
unit 
string 
Unit representation.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/MedicationDispense/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationDispense/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "MedicationDispense",
            "id": "a47c7b0e-bbb4-42cd-bc4a-df259d148ea1",
            "status": "completed",
            "medicationCodeableConcept": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "244899",
                        "display": "lisinopril 10 mg tablet"
                    },
                    {
                        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                        "code": "314076",
                        "display": "lisinopril 10 mg tablet"
                    }
                ]
            },
            "subject": {
                "reference": "Patient/6cb2a409334943c2b48f1686dc739f11",
                "type": "Patient"
            },
            "performer": [
                {
                    "actor": {
                        "reference": "Practitioner/6c20b7152cf7421791c5ab4113060b3f",
                        "type": "Practitioner"
                    }
                }
            ],
            "authorizingPrescription": [
                {
                    "reference": "MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e",
                    "type": "MedicationRequest"
                }
            ],
            "type": {
                "text": "Office-supplied"
            },
            "quantity": {
                "value": 30
            },
            "whenHandedOver": "2023-09-21T18:35:00.000+00:00",
            "dosageInstruction": [
                {
                    "text": "take 1 daily",
                    "timing": {
                      "event": [
                        "2023-09-21T18:35:00.000+00:00"
                      ]
                    },
                    "doseAndRate": [
                        {
                            "doseQuantity": {
                                "value": 5,
                                "unit": "Tablet"
                            }
                        }
                    ]
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown MedicationDispense resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/MedicationDispense?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationDispense?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/MedicationDispense?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/MedicationDispense?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/MedicationDispense?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "MedicationDispense",
                        "id": "a47c7b0e-bbb4-42cd-bc4a-df259d148ea1",
                        "status": "completed",
                        "medicationCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://www.fdbhealth.com/",
                                    "code": "244899",
                                    "display": "lisinopril 10 mg tablet"
                                },
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "314076",
                                    "display": "lisinopril 10 mg tablet"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/6cb2a409334943c2b48f1686dc739f11",
                            "type": "Patient"
                        },
                        "performer": [
                            {
                                "actor": {
                                    "reference": "Practitioner/6c20b7152cf7421791c5ab4113060b3f",
                                    "type": "Practitioner"
                                }
                            }
                        ],
                        "authorizingPrescription": [
                            {
                                "reference": "MedicationRequest/3423a69c-618d-4cbe-861a-54c60f48744e",
                                "type": "MedicationRequest"
                            }
                        ],
                        "type": {
                            "text": "Office-supplied"
                        },
                        "quantity": {
                            "value": 30
                        },
                        "whenHandedOver": "2023-09-21T18:35:00.000+00:00",
                        "dosageInstruction": [
                            {
                                "text": "take 1 daily",
                                "timing": {
                                    "event": [
                                        "2023-09-21T18:35:00.000+00:00"
                                    ]
                                },
                                "doseAndRate": [
                                    {
                                        "doseQuantity": {
                                            "value": 5,
                                            "unit": "Tablet"
                                        }
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/medicationdispense/


----- BEGIN PAGE https://docs.canvasmedical.com/api/medicationrequest/
### 
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html>  
FHIR MedicationRequest maps to the [Prescribe, Refill, Adjust Prescription, Deny Refill, Approve Refill](https://canvas-medical.help.usepylon.com/articles/5128727084-managing-medication-commands) commands in Canvas.
### Endpoints
get /MedicationRequest/{id} get /MedicationRequest
get
/MedicationRequest/{id}
#### MedicationRequest read
Read a MedicationRequest resource.
### Path Parameters
id required
string 
The unique identifier for the MedicationRequest   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the MedicationRequest.
status 
enum [ active | entered-in-error | cancelled | stopped | unknown ] 
A code specifying the current state of the order.
intent 
enum [ order | filler-order ] 
Whether the request is a proposal, plan, or an original order.   
A Medication Request that corresponds to a refill in the patient's chart will have an intent of `filler-order` while all other Medication Requests will be `order`.
category 
array[json] 
Indicates the type of medication request. Currently, all medication requests from Canvas are categorized as "outpatient".
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/medicationrequest-category 
code 
string 
The code of the category.
**Value Options Supported:**
  - outpatient 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Outpatient 
reportedBoolean 
boolean 
Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record.  
Currently this will always be False from Canvas.
medicationCodeableConcept 
json 
Identifies the medication being requested. This is simply an attribute carrying a code that identifies the medication from a known list of medications.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
subject 
json 
Who the medication request is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter created as part of encounter/admission/stay.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/f7663d7b-13bd-4236-843e-086306aea125"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
authoredOn 
datetime 
When request was initially authored. In Canvas this corresponds to the time the command was created.
requester 
json 
Who/What requested the Request.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
performer [deprecated] 
json 
Intended performer of administration  
This attribute is deprecated and will be removed in a future release. It currently (and incorrectly) contains information about the dispenser of the medication. Canvas recommends disregarding this attribute. Information about the dispenser can be obtained from the `performer` attribute under `dispenseRequest`.
reasonCode 
array[json] 
Reason or indication for ordering or not ordering the medication.  
In Canvas this represents the indications on a Prescribe/Refill Command.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string 
The code of the indication.
display 
string 
The display name of the coding.
note 
array[json] 
Information about the prescription.
Click to view child attributes
text 
string 
The annotation - text content.
dosageInstruction 
array[json] 
How the medication should be taken.
Click to view child attributes
text 
string 
Free text dosage instructions. In Canvas this text comes from the `SIG` or `DIRECTIONS` field on the associated command.
timing 
json 
When medication should be administered.
Click to view child attributes
event 
array[datetime] 
Identifies specific times when the event takes place.
doseAndRate 
array[json] 
Amount of medication administered.
Click to view child attributes
doseQuantity 
json 
Amount of medication per dose.
Click to view child attributes
value 
decimal 
Numerical value
unit 
string 
Unit representation.
dispenseRequest 
json 
Medication supply authorization.
Click to view child attributes
numberOfRepeatsAllowed 
integer 
Number of refills authorized.
quantity 
json 
Amount of medication to supply per dispense.
Click to view child attributes
value 
decimal 
Numerical value.
expectedSupplyDuration 
json 
Number of days supply per dispense.
Click to view child attributes
value 
integer 
Numerical value.
unit 
string 
Unit representation.
**Value Options Supported:**
  - days 
performer 
json 
Intended dispenser. In Canvas this represents the pharmacy the medication request was sent to.
Click to view child attributes
display 
string 
Text alternative for the resource.   
This display name concatenates the following information about the pharmacy: Name, NCPDP ID, Address, Phone, and Fax
substitution 
json 
Any restrictions on medication substitution.
Click to view child attributes
allowedBoolean 
boolean 
Whether substitution is allowed or not.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/MedicationRequest
#### MedicationRequest search
Search for MedicationRequest resources.
### Query Parameters
****
_id 
string 
The identifier of the MedicationRequest.
intent 
string 
Search Medication Requests by specific intents.
**Search Values Supported:**
  - order
  - filler-order
patient 
string 
The patient reference associated with the MedicationRequest in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
requester 
string 
The Practitioner reference associated to the MedicationRequest.requester attribute in the format `Practitioner/6c20b7152cf7421791c5ab4113060b3f`.
status 
string 
Search Medication Requests by a specific status.
**Search Values Supported:**
  - active
  - entered-in-error
  - cancelled
  - stopped
_include 
string 
Include referenced resources in the search bundle. The supported value is `MedicationRequest:medication`, which adds the referenced Medication resources to the response.
**Search Values Supported:**
  - MedicationRequest:medication
_revinclude 
string 
Standard FHIR `_revinclude` parameter.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the MedicationRequest.
status 
enum [ active | entered-in-error | cancelled | stopped | unknown ] 
A code specifying the current state of the order.
intent 
enum [ order | filler-order ] 
Whether the request is a proposal, plan, or an original order.   
A Medication Request that corresponds to a refill in the patient's chart will have an intent of `filler-order` while all other Medication Requests will be `order`.
category 
array[json] 
Indicates the type of medication request. Currently, all medication requests from Canvas are categorized as "outpatient".
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/medicationrequest-category 
code 
string 
The code of the category.
**Value Options Supported:**
  - outpatient 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Outpatient 
reportedBoolean 
boolean 
Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record.  
Currently this will always be False from Canvas.
medicationCodeableConcept 
json 
Identifies the medication being requested. This is simply an attribute carrying a code that identifies the medication from a known list of medications.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code of the medication.
display 
string 
The display name of the coding.
subject 
json 
Who the medication request is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
encounter 
json 
Encounter created as part of encounter/admission/stay.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/f7663d7b-13bd-4236-843e-086306aea125"`.
type 
string 
Type the reference refers to (e.g. "Encounter").
authoredOn 
datetime 
When request was initially authored. In Canvas this corresponds to the time the command was created.
requester 
json 
Who/What requested the Request.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Practitioner/ed1e304acdb847148338c6b0596d93fd"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
performer [deprecated] 
json 
Intended performer of administration  
This attribute is deprecated and will be removed in a future release. It currently (and incorrectly) contains information about the dispenser of the medication. Canvas recommends disregarding this attribute. Information about the dispenser can be obtained from the `performer` attribute under `dispenseRequest`.
reasonCode 
array[json] 
Reason or indication for ordering or not ordering the medication.  
In Canvas this represents the indications on a Prescribe/Refill Command.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/icd-10-cm 
code 
string 
The code of the indication.
display 
string 
The display name of the coding.
note 
array[json] 
Information about the prescription.
Click to view child attributes
text 
string 
The annotation - text content.
dosageInstruction 
array[json] 
How the medication should be taken.
Click to view child attributes
text 
string 
Free text dosage instructions. In Canvas this text comes from the `SIG` or `DIRECTIONS` field on the associated command.
timing 
json 
When medication should be administered.
Click to view child attributes
event 
array[datetime] 
Identifies specific times when the event takes place.
doseAndRate 
array[json] 
Amount of medication administered.
Click to view child attributes
doseQuantity 
json 
Amount of medication per dose.
Click to view child attributes
value 
decimal 
Numerical value
unit 
string 
Unit representation.
dispenseRequest 
json 
Medication supply authorization.
Click to view child attributes
numberOfRepeatsAllowed 
integer 
Number of refills authorized.
quantity 
json 
Amount of medication to supply per dispense.
Click to view child attributes
value 
decimal 
Numerical value.
expectedSupplyDuration 
json 
Number of days supply per dispense.
Click to view child attributes
value 
integer 
Numerical value.
unit 
string 
Unit representation.
**Value Options Supported:**
  - days 
performer 
json 
Intended dispenser. In Canvas this represents the pharmacy the medication request was sent to.
Click to view child attributes
display 
string 
Text alternative for the resource.   
This display name concatenates the following information about the pharmacy: Name, NCPDP ID, Address, Phone, and Fax
substitution 
json 
Any restrictions on medication substitution.
Click to view child attributes
allowedBoolean 
boolean 
Whether substitution is allowed or not.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/MedicationRequest/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationRequest/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "MedicationRequest",
            "id": "3423a69c-618d-4cbe-861a-54c60f48744e",
            "status": "active",
            "intent": "order",
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                            "code": "outpatient",
                            "display": "Outpatient"
                        }
                    ]
                }
            ],
            "reportedBoolean": false,
            "medicationCodeableConcept": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "244899",
                        "display": "lisinopril 10 mg tablet"
                    },
                    {
                        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                        "code": "314076",
                        "display": "lisinopril 10 mg tablet"
                    }
                ]
            },
            "subject": {
                "reference": "Patient/6cb2a409334943c2b48f1686dc739f11",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/bdadce18-098b-40dc-8bdd-ef8481bd999a",
                "type": "Encounter"
            },
            "authoredOn": "2023-09-21T18:19:36.106449+00:00",
            "requester": {
                "reference": "Practitioner/6c20b7152cf7421791c5ab4113060b3f",
                "type": "Practitioner"
            },
            "performer": {
                "display": "Name: CVS Health #68534|NCPDP ID: 0068534|Address: 1 Cvs Dr, Woonsocket, RI, 028956146|Phone: 4017702500|Fax: 4017704486"
            },
            "reasonCode": [
                {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/sid/icd-10-cm",
                            "code": "I10",
                            "display": "Essential (primary) hypertension"
                        }
                    ]
                }
            ],
            "dosageInstruction": [
                {
                    "text": "take 1 daily",
                    "timing": {
                        "event": ["2023-09-21T18:19:36.106449+00:00"]
                    },
                    "doseAndRate": [
                        {
                            "doseQuantity": {
                                "value": 5,
                                "unit": "Tablet"
                            }
                        }
                    ]
                }
            ],
            "dispenseRequest": {
                "numberOfRepeatsAllowed": 3,
                "quantity": {
                    "value": 30.0
                },
                "expectedSupplyDuration": {
                    "value": 30,
                    "unit": "days"
                },
                "performer": {
                    "display": "Name: CVS Health #68534|NCPDP ID: 0068534|Address: 1 Cvs Dr, Woonsocket, RI, 028956146|Phone: 4017702500|Fax: 4017704486"
                }
            },
            "substitution": {
                "allowedBoolean": true
            }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown MedicationRequest resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/MedicationRequest?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationRequest?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/MedicationRequest?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/MedicationRequest?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/MedicationRequest?patient=Patient%2F6cb2a409334943c2b48f1686dc739f11&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "MedicationRequest",
                        "id": "3423a69c-618d-4cbe-861a-54c60f48744e",
                        "status": "active",
                        "intent": "order",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                                        "code": "outpatient",
                                        "display": "Outpatient"
                                    }
                                ]
                            }
                        ],
                        "reportedBoolean": false,
                        "medicationCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://www.fdbhealth.com/",
                                    "code": "244899",
                                    "display": "lisinopril 10 mg tablet"
                                },
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "314076",
                                    "display": "lisinopril 10 mg tablet"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/6cb2a409334943c2b48f1686dc739f11",
                            "type": "Patient"
                        },
                        "encounter": {
                            "reference": "Encounter/bdadce18-098b-40dc-8bdd-ef8481bd999a",
                            "type": "Encounter"
                        },
                        "authoredOn": "2023-09-21T18:19:36.106449+00:00",
                        "requester": {
                            "reference": "Practitioner/6c20b7152cf7421791c5ab4113060b3f",
                            "type": "Practitioner"
                        },
                        "performer": {
                            "display": "Name: CVS Health #68534|NCPDP ID: 0068534|Address: 1 Cvs Dr, Woonsocket, RI, 028956146|Phone: 4017702500|Fax: 4017704486"
                        },
                        "reasonCode": [
                            {
                                "coding": [
                                    {
                                        "system": "http://hl7.org/fhir/sid/icd-10-cm",
                                        "code": "I10",
                                        "display": "Essential (primary) hypertension"
                                    }
                                ]
                            }
                        ],
                        "dosageInstruction": [
                            {
                                "text": "take 1 daily",
                                "timing": {
                                    "event": ["2023-09-21T18:19:36.106449+00:00"]
                                },
                                "doseAndRate": [
                                    {
                                        "doseQuantity": {
                                            "value": 5,
                                            "unit": "Tablet"
                                        }
                                    }
                                ]
                            }
                        ],
                        "dispenseRequest": {
                            "numberOfRepeatsAllowed": 3,
                            "quantity": {
                                "value": 30.0
                            },
                            "expectedSupplyDuration": {
                                "value": 30,
                                "unit": "days"
                            },
                            "performer": {
                                "display": "Name: CVS Health #68534|NCPDP ID: 0068534|Address: 1 Cvs Dr, Woonsocket, RI, 028956146|Phone: 4017702500|Fax: 4017704486"
                            }
                        },
                        "substitution": {
                            "allowedBoolean": true
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/medicationrequest/


----- BEGIN PAGE https://docs.canvasmedical.com/api/medicationstatement/
### 
A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains.  
<https://hl7.org/fhir/R4/medicationstatement.html>  
MedicationStatement resources can be created in two ways in the Canvas UI:
  - [Prescribe commands](https://canvas-medical.help.usepylon.com/articles/5128727084-managing-medication-commands#prescribe-command-7) create [MedicationRequest](/api/medicationrequest/) resources, but these `Prescribe` commands are also represented as MedicationStatement resources. MedicationStatement resources that were created with a `Prescribe` command will contain a reference to the related MedicationRequest resource in the `derivedFrom` attribute.
  - MedicationStatement resources can also be created with the [Medication Statement command](https://canvas-medical.help.usepylon.com/articles/5128727084-managing-medication-commands#medication-statement-command-1)
### Endpoints
post /MedicationStatement get /MedicationStatement/{id} put /MedicationStatement/{id} get /MedicationStatement
post
/MedicationStatement
#### MedicationStatement create
Create a MedicationStatement resource.  
If `context` or `extension` is provided, the MedicationStatement will be added to the existing encounter (note). If it is not provided, a new data import note will be created.  
Create requests support either `medicationReference` or `medicationCodeableConcept` in the request body; Canvas recommends using `medicationReference`. Medication identifiers for `medicationReference` can be obtained from the [Medication search endpoint](/api/medication/#search).
### Attributes
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note. If neither is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string required
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
string required
A code representing the patient or other source's judgment about the state of the medication used that this statement is about.
**Value Options Supported:**
  - active 
  - entered-in-error 
  - stopped 
medicationReference 
json 
What medication was taken.   
Canvas recommends using a medicationReference on create/update to ensure a proper medication lookup is done on validation similar to our commands framework on the Canvas UI. Use the [Medication search endpoint](/api/medication/#search) to help find the correct FDB ID.   
A create/update requires either a medicationReference or medicationCodeableConcept when making a request
Click to view child attributes
reference 
string required
The reference string of the medication in the format of `"Medication/fdb-449732"`
display 
string required
The display name of the medication
medicationCodeableConcept 
json 
What medication was taken.   
Canvas recommends using a medicationReference on create/update; however on a Read/Search the medicationCodeableConcept will be returned to allow visibility into all the coding associated with the medication (e.g RxNorm, FDB)   
A create/update requires either a medicationReference or medicationCodeableConcept when making a request.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The url of the medication coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string required
The code value of the medication coding
display 
string required
The display name of the medication
subject 
json required
Who is/was taking the medication.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
context 
json 
Encounter / Episode associated with MedicationStatement.  
Supply an encounter reference to be able to insert the command into a specific note on the patient's timeline. If no encounter or note via the extension is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.   
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string required
The reference string of the encounter in the format of `"Encounter/948b54e2-40b7-4648-bfce-e2373f9802af"`
type 
string 
Type the reference refers to (e.g. "Encounter")
effectivePeriod 
json 
The interval when the medication is/was/will be taken.
Click to view child attributes
start 
datetime 
The datetime string represented the start time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
If omitted this will default to the current timestamp.
end 
datetime 
The datetime string represented the end time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
If omitted, this field will be left empty.
dosage 
array[json] 
Details of how medication is/was taken or should be taken.  
The `text` attribute for the Dosage object contains the SIG.
Canvas will only ingest the first item in the dosage array.
Click to view child attributes
text 
string 
The SIG of the medication
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/MedicationStatement/{id}
#### MedicationStatement read
Read an MedicationStatement resource.  
Read responses will always contain a `medicationCodeableConcept` regardless of what was used to create the MedicationStatement.
### Path Parameters
id required
string 
The unique identifier for the MedicationStatement   
### Response Payload Attributes
id 
string 
The identifier of the MedicationStatement.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
string 
A code representing the patient or other source's judgment about the state of the medication used that this statement is about.
**Value Options Supported:**
  - active 
  - entered-in-error 
  - stopped 
  - intended (Medications where the effectivePeriod.start date is in the future)
  - unknown (Returned when the source state cannot be mapped to one of the other values.)
medicationCodeableConcept 
json 
What medication was taken.   
Canvas recommends using a medicationReference on create/update; however on a Read/Search the medicationCodeableConcept will be returned to allow visibility into all the coding associated with the medication (e.g RxNorm, FDB)   
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The url of the medication coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code value of the medication coding
display 
string 
The display name of the medication
subject 
json 
Who is/was taking the medication.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
effectivePeriod 
json 
The interval when the medication is/was/will be taken.
Click to view child attributes
start 
datetime 
The datetime string represented the start time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
end 
datetime 
The datetime string represented the end time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
dateAsserted 
datetime 
When the statement was asserted. This is autogenerated on a create request as the timestamp of ingestion.
derivedFrom 
array[json] 
This will display if the medication was added to the Patient's chart via a MedicationRequest (prescribe or refill command).
Click to view child attributes
reference 
string 
The reference string of the MedicationRequest in the format of `"MedicationRequest/948b54e2-40b7-4648-bfce-e2373f9802af"`
type 
string 
Type the reference refers to (e.g. "MedicationRequest")
dosage 
array[json] 
Details of how medication is/was taken or should be taken.  
The `text` attribute for the Dosage object contains the SIG.
Click to view child attributes
text 
string 
The SIG of the medication
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/MedicationStatement/{id}
#### MedicationStatement update
Update an MedicationStatement resource.  
The only type of MedicationStatement update interaction that is supported by Canvas is to mark an existing MedicationStatement as **entered-in-error**. No changes to other fields will be processed.
### Attributes
id 
string required
The identifier of the MedicationStatement.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string required
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
string required
A code representing the patient or other source's judgment about the state of the medication used that this statement is about.
**Value Options Supported:**
  - entered-in-error 
medicationReference 
json 
What medication was taken.   
Canvas recommends using a medicationReference on create/update to ensure a proper medication lookup is done on validation similar to our commands framework on the Canvas UI. Use the [Medication search endpoint](/api/medication/#search) to help find the correct FDB ID.   
A create/update requires either a medicationReference or medicationCodeableConcept when making a request
Click to view child attributes
reference 
string required
The reference string of the medication in the format of `"Medication/fdb-449732"`
display 
string required
The display name of the medication
medicationCodeableConcept 
json 
What medication was taken.   
Canvas recommends using a medicationReference on create/update; however on a Read/Search the medicationCodeableConcept will be returned to allow visibility into all the coding associated with the medication (e.g RxNorm, FDB)   
A create/update requires either a medicationReference or medicationCodeableConcept when making a request.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The url of the medication coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string required
The code value of the medication coding
display 
string required
The display name of the medication
subject 
json required
Who is/was taking the medication.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
context 
json 
Encounter / Episode associated with MedicationStatement.  
Supply an encounter reference to be able to insert the command into a specific note on the patient's timeline. If no encounter or note via the extension is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.   
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string required
The reference string of the encounter in the format of `"Encounter/948b54e2-40b7-4648-bfce-e2373f9802af"`
type 
string 
Type the reference refers to (e.g. "Encounter")
effectivePeriod 
json 
The interval when the medication is/was/will be taken.
Click to view child attributes
start 
datetime 
The datetime string represented the start time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
end 
datetime 
The datetime string represented the end time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
dosage 
array[json] 
Details of how medication is/was taken or should be taken.  
The `text` attribute for the Dosage object contains the SIG.
Click to view child attributes
text 
string 
The SIG of the medication
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/MedicationStatement
#### MedicationStatement search
Search for MedicationStatement resources.  
Search bundle entries will always contain values for `medicationCodeableConcept` regardless of what was used to create the MedicationStatement.
### Query Parameters
****
_id 
string 
The identifier of the MedicationStatement.
patient 
string 
The patient reference associated to the Medication Statement in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
id 
string 
The identifier of the MedicationStatement.
extension 
array[json] 
Canvas supports a note identifier extension on this resource. The note identifier can be used with the [Canvas Note API](/api/note).
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/note-id 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier.
status 
string 
A code representing the patient or other source's judgment about the state of the medication used that this statement is about.
**Value Options Supported:**
  - active 
  - entered-in-error 
  - stopped 
  - intended (Medications where the effectivePeriod.start date is in the future)
  - unknown (Returned when the source state cannot be mapped to one of the other values.)
medicationCodeableConcept 
json 
What medication was taken.   
Canvas recommends using a medicationReference on create/update; however on a Read/Search the medicationCodeableConcept will be returned to allow visibility into all the coding associated with the medication (e.g RxNorm, FDB)   
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The url of the medication coding.
**Value Options Supported:**
  - http://www.nlm.nih.gov/research/umls/rxnorm 
  - http://www.fdbhealth.com/ 
code 
string 
The code value of the medication coding
display 
string 
The display name of the medication
subject 
json 
Who is/was taking the medication.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
effectivePeriod 
json 
The interval when the medication is/was/will be taken.
Click to view child attributes
start 
datetime 
The datetime string represented the start time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
end 
datetime 
The datetime string represented the end time of the medication in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.
dateAsserted 
datetime 
When the statement was asserted. This is autogenerated on a create request as the timestamp of ingestion.
derivedFrom 
array[json] 
This will display if the medication was added to the Patient's chart via a MedicationRequest (prescribe or refill command).
Click to view child attributes
reference 
string 
The reference string of the MedicationRequest in the format of `"MedicationRequest/948b54e2-40b7-4648-bfce-e2373f9802af"`
type 
string 
Type the reference refers to (e.g. "MedicationRequest")
dosage 
array[json] 
Details of how medication is/was taken or should be taken.  
The `text` attribute for the Dosage object contains the SIG.
Click to view child attributes
text 
string 
The SIG of the medication
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/MedicationStatement' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "MedicationStatement",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5",
                }
            ],
            "status": "active",
            "medicationReference": {
                "reference": "Medication/fdb-259181",
                "display": "Advil 200 mg tablet"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "context": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "effectivePeriod": {
                "start": "2023-06-15T15:00:00-04:00",
                "end": "2023-06-25T15:00:00-04:00"
            },
            "dosage": [
                {
                    "text": "1-2 tablets once daily at bedtime as needed for restless legs"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationStatement"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "MedicationStatement",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5",
                }
            ],
            "status": "active",
            "medicationReference": {
                "reference": "Medication/fdb-259181",
                "display": "Advil 200 mg tablet"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "context": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "effectivePeriod": {
                "start": "2023-06-15T15:00:00-04:00",
                "end": "2023-06-25T15:00:00-04:00"
            },
            "dosage": [
                {
                    "text": "1-2 tablets once daily at bedtime as needed for restless legs"
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/MedicationStatement/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationStatement/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "MedicationStatement",
            "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
            "status": "active",
            "medicationCodeableConcept": {
                "coding": [
                    {
                        "system": "http://www.fdbhealth.com/",
                        "code": "259181",
                        "display": "Advil 200 mg tablet"
                    },
                    {
                        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                        "code": "310965",
                        "display": "Advil 200 mg tablet"
                    }
                ]
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "context": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "dateAsserted": "2023-06-15T15:00:00-04:00",
            "effectivePeriod": {
                "start": "2023-06-15T15:00:00-04:00",
                "end": "2023-06-25T15:00:00-04:00"
            },
            "dosage": [
                {
                    "text": "1-2 tablets once daily at bedtime as needed for restless legs"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown MedicationStatement resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/MedicationStatement/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "MedicationStatement",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5",
                }
            ],
            "status": "entered-in-error",
            "medicationReference": {
                "reference": "Medication/fdb-259181",
                "display": "Advil 200 mg tablet"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "context": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "effectivePeriod": {
                "start": "2023-06-15T15:00:00-04:00",
                "end": "2023-06-25T15:00:00-04:00"
            },
            "dosage": [
                {
                    "text": "1-2 tablets once daily at bedtime as needed for restless legs"
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationStatement/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "MedicationStatement",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5",
                }
            ],
            "status": "entered-in-error",
            "medicationReference": {
                "reference": "Medication/fdb-259181",
                "display": "Advil 200 mg tablet"
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
            },
            "context": {
                "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
            },
            "effectivePeriod": {
                "start": "2023-06-15T15:00:00-04:00",
                "end": "2023-06-25T15:00:00-04:00"
            },
            "dosage": [
                {
                    "text": "1-2 tablets once daily at bedtime as needed for restless legs"
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown MedicationStatement resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/MedicationStatement?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/MedicationStatement?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/MedicationStatement?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/MedicationStatement?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/MedicationStatement?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "MedicationStatement",
                        "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
                        "status": "active",
                        "medicationCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://www.fdbhealth.com/",
                                    "code": "259181",
                                    "display": "Advil 200 mg tablet"
                                },
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "310965",
                                    "display": "Advil 200 mg tablet"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
                        },
                        "context": {
                            "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
                        },
                        "effectivePeriod": {
                            "start": "2023-06-15T15:00:00-04:00",
                            "end": "2023-06-25T15:00:00-04:00"
                        },
                        "dosage": [
                            {
                                "text": "1-2 tablets once daily at bedtime as needed for restless legs"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/medicationstatement/


----- BEGIN PAGE https://docs.canvasmedical.com/api/note/
This API allows customers to create and update notes. The effect of creating a note is the same as creating a note in the user interface (for example for a note with category "encounter" will create an encounter, a note that is billable will create a claim). Not all note attributes can be modified on update. For example, note type cannot be changed after note creation.
##  Authentication 
The Note API uses the existing OAuth authentication flow from the FHIR API, so you can simply post to the existing auth token endpoint /auth/token/
New scopes are introduced: user/Note.read and user/Note.write. These scopes will not be in OAuth applications that were created prior to the release of this feature. Therefore to get access, you have two options:
  - Create a new [OAuth application](/api/customer-authentication)
  - Ask Canvas to add the new scopes to an existing OAuth application
![description](/assets/images/allowed-scopes.png)
    ```python
    import requests
    url = "https://<your-instance>.canvasmedical.com/auth/token/"
    payload = 'grant_type=client_credentials&client_id=canvas&client_secret=canvas'
    headers = {
      'Content-Type': 'application/x-www-form-urlencoded'
    }
    response = requests.request("POST", url, headers=headers, data=payload)
    print(response.text)
    ```
Then use your token in the request headers as you do with the FHIR API:
![description](/assets/images/note-api-token.png)
##  Create 
To create a Note resource, POST to `https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note` using the supported attributes below. Notes will be created with the state "NEW" by default.
###  Attributes 
**`title`** text  
The user-defined title of the Note.
* * *
**`encounterStartTime`** datetime  
The datetime of the encounter. This will display in the datetimeOfService.
* * *
**`patientKey`** text  
The unique key of the Patient for which this Note is written.
* * *
**`providerKey`** text  
The unique key of the Provider staff who is writing the Note.
* * *
**`practiceLocationKey`** text  
The unique key of the PracticeLocation for which this Note is written.
* * *
**`noteTypeName text`**  
Represents the note type in a human-readable format.
* * *
**`noteTypeSystem`** text  
Defines a coding system for the note type, to be used with the paired noteTypeCoding.
* * *
**`noteTypeCoding`** text  
Defines a code for the note type, to be used with the paired noteTypeSystem.
###  Example 
    ```python
    import requests
    import json
    url = "https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note"
    payload = json.dumps({
      "title": "Some Custom Title",
      "noteTypeName": "Office visit",
      "patientKey": "8d84776879de49518a4bc3bb81d96dd4",
      "providerKey": "5eede137ecfe4124b8b773040e33be14",
      "practiceLocationKey": "c67e0c59-d4d2-428c-bc13-b6e85d181ad0",
      "encounterStartTime": "2023-11-28T19:00:00.016852Z"
    })
    headers = {
      'Authorization': 'Bearer HqFtbSnBNX4S65VhRrg8sRxO6XcSFp',
      'Content-Type': 'application/json'
    }
    response = requests.request("POST", url, headers=headers, data=payload)
    print(response.text)
    ```
##  Read 
To read a Note resource, request a GET from   
`https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note/{noteKey}`
###  Attributes 
**`noteKey`** string  
The unique key of the Note.
* * *
**`title`** text  
The user-defined title of the Note.
* * *
**`datetimeOfService`** datetime  
The datetime of the service, as defined as encounter start time for encounters, appointment datetime for appointments, or the created datetime for other note types.
* * *
**`titleDisplay`** text  
Represents the computed title of the Note, as displayed in the UI. If a user-defined title is not provided, this defaults to other display logic.
* * *
**`currentState`** text  
The most recent state of the Note.
* * *
**`patientKey`** text  
The unique key of the Patient for which this Note was written.
* * *
**`providerKey`** text  
The unique key of the Provider staff who wrote the Note.
* * *
**`practiceLocationKey`** text  
The unique key of the PracticeLocation for which this Note was written.
* * *
**`noteTypeName text`**  
Represents the note type in a human-readable format.
* * *
**`noteTypeSystem`** text  
Defines a coding system for the note type, to be used with the paired noteTypeCoding.
* * *
**`noteTypeCoding`** text  
Defines a code for the note type, to be used with the paired noteTypeSystem.
###  Example 
    ```python
    import requests
    url = "https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note/4a6064e9-293c-4541-b1cc-515f81435e74"
    payload = ""
    headers = {
      'Authorization': 'Bearer QdPhY9QLIs4zlawv5UG42JDASGqX0l'
    }
    response = requests.request("GET", url, headers=headers, data=payload)
    print(response.text)
    ```
##  Update 
To update an existing Note resource, `PATCH` to   
`https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note/{noteKey}`   
using any of the following allowed attributes.
###  Attributes 
**`title`** text  
The user-defined title of the Note.
* * *
**`providerKey`** text  
The unique key of the Provider staff who is writing the Note.
* * *
**`practiceLocationKey`** text  
The unique key of the PracticeLocation for which this Note is written.
* * *
**`stateChange`** text   
The new note state to be set. Allowed transitions in v1 include:
Locking an unlocked note (excluding DATA notes). Locking a note will result in the Note PDF being generated along with it associated FHIR DocumentReference record.   
"ULK" → "LKD", "NEW" → "LKD", "CVD" → "LKD"  
Unlocking a locked note (excluding DATA notes)  
"LKD" → "ULK"  
Marking an appointment as a no show   
"BKD" → "NSW" & "RVT" → "NSW"  
Checking in an appointment  
"BKD" → "CVD", "NSW" → "CVD", "RVT" → "CVD"
###  Example 
    ```python
    import requests
    import json
    url = "https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note/4a6064e9-293c-4541-b1cc-515f81435e74"
    payload = json.dumps({
      "stateChange": "LKD",
      "providerKey": "4150cd20de8a470aa570a852859ac87e",
      "practiceLocationKey": "c67e0c59-d4d2-428c-bc13-b6e85d181ad0",
      "title": "New Custom Title"
    })
    headers = {
      'Authorization': 'Bearer QdPhY9QLIs4zlawv5UG42JDASGqX0l',
      'Content-Type': 'application/json'
    }
    response = requests.request("PATCH", url, headers=headers, data=payload)
    print(response.text)
    ```
##  Search 
To search for Note resources, request a `GET` from   
`https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note`   
and append your search criteria as URL parameters.
###  Query Params 
**patient_key** text filters to this patient's notes only
**provider_key** text filters to this provider's notes only
**note_type_name** text filters to this type of note (human-readable)
**note_type_system** and **note_type_coding** text filters to this type of note with system/code pair
**datetime_of_service** datetime filters the service datetime with the following options:
  - = (exact)
  - lte (less than or equal to)
  - gte (greater than or equal to)
  - lt (less than)
  - gt (greater than)
`&datetime_of_service__gte=2023-12-06T19:10:56.115532Z`
###  Pagination 
To paginate your requests, simply add a limit query parameter, e.g. `GET` from `https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note?limit=10`. You can also page through the results with the offset parameter, e.g. `https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note?limit=10&offset=10`. The response will include a record count, as well as **next** , and **previous** URLs for convenience, and the note data will be contained in the **results** value.
###  Ordering 
To order your results, simply add an ordering query parameter, e.g. `GET` from `https://<your-instance>.canvasmedical.com/core/api/notes/v1/Note?ordering=datetime_of_service`. To reverse the sort order, prepend the field with a hyphen, e.g. `?ordering=-datetime_of_service`. Available ordering fields include:
  - created (the datetime the note was created)
  - modified (the datetime the note was last updated)
  - datetime_of_service (the datetime of the actual service associated with the note)
###  Example 
    ```python
    import requests
    url = "https://<your_instance>.canvasmedical.com/core/api/notes/v1/Note?patient_key=8d84776879de49518a4bc3bb81d96dd4&note_type_name=Office%20visit"
    payload = ""
    headers = {
      'Authorization': 'Bearer QdPhY9QLIs4zlawv5UG42JDASGqX0l'
    }
    response = requests.request("GET", url, headers=headers, data=payload)
    print(response.text)
    ```
----- END PAGE https://docs.canvasmedical.com/api/note/


----- BEGIN PAGE https://docs.canvasmedical.com/api/observation/
### 
Measurements and simple assertions made about a patient, device or other subject.  
Canvas supports the following US Core Profiles for Observations:  
  - [US Core Observation Clinical Result Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-clinical-result.html)
  - [US Core Laboratory Result Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-lab.html)
  - [US Core Observation Occupation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-occupation.html)
  - [US Core Observation Pregnancy Intent Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-pregnancyintent.html)
  - [US Core Observation Pregnancy Status Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-pregnancystatus.html)
  - [US Core Observation Screening Assessment Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-screening-assessment.html)
  - [US Core Observation Sexual Orientation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-sexual-orientation.html)
  - [US Core Simple Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-simple-observation.html)
  - [US Core Smoking Status Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-smokingstatus.html)
  - [US Core Vital Signs Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-vital-signs.html)
  - [US Core Pediatric Head Occipital-frontal Circumference Percentile Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-head-occipital-frontal-circumference-percentile.html)
  - [US Core Pediatric BMI for Age Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-pediatric-bmi-for-age.html)
  - [US Core Pediatric Weight for Height Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-pediatric-weight-for-height.html)
  - [US Core Blood Pressure Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-blood-pressure.html)
  - [US Core BMI Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-bmi.html)
  - [US Core Body Height Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-body-height.html)
  - [US Core Body Temperature Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-body-temperature.html)
  - [US Core Body Weight Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-body-weight.html)
  - [US Core Head Circumference Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-head-circumference.html)
  - [US Core Heart Rate Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-heart-rate.html)
  - [US Core Pulse Oximetry Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-pulse-oximetry.html)
  - [US Core Respiratory Rate Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-respiratory-rate.html)
The following USCDI data elements are retrievable from this endpoint:  
  - Laboratory Tests
  - Laboratory Values/Results
  - Smoking Status
Here are some Canvas specific workflows where observations will be created:
  1. Documenting Vitals via our [Vital Command](https://canvas-medical.help.usepylon.com/articles/9426091672-command-vitals) (category coding will be `vital-signs`)  
  2. Submitting a Questionnaire, Review Of System (ROS), Structured Assessment (SA), or a Physical Exam will result in an observation for each question answered if the question's code system is LOINC or SNOMED (category coding will be `social-history`).   
  3. There is a specific Physical Exam to capture Pediatric Vitals. Upon submission of the Exam, associated observations for Body Length, Head Circumference, and Head Occipital-Frontal Circumference Percentile (category coding will be `vital-signs`) will be created along with the observations for the answers of the exam (category coding will be `social-history`). Please contact Customer Support for help loading this Exam into your instance if you want to utilize it.   
  4. Once weight and either height or pediatric body length is entered on a patients chart, the vital observations of BMI for Age Percentile (for patients 2 years or older) and Weight-for-Length Percentile will be calculated (category coding will be `vital-signs`).
  5. Submitting a Questionnaire that has custom scoring defined will result in an observation containing the scored value (category coding will be `survey`).   
  6. When a lab report is created in Canvas through [DI](https://canvas-medical.help.usepylon.com/articles/1652834476-labs-lab-reports), API, integration with HG, or [POC Lab Test Command](https://canvas-medical.help.usepylon.com/articles/7060961677-point-of-care-poc-tests), there will be resulting Observations made (category coding will be `laboratory`).
**Related guides:**
  - [Submit a Full Vital Panel through Canvas FHIR API](/guides/submit-vitals-via-fhir/)
### Endpoints
post /Observation get /Observation/{id} get /Observation
post
/Observation
#### Observation create
Although the observation endpoint houses many different Canvas models, currently, **only vital signs and panels can be created through this endpoint**.  
**Vital signs and Vital Sign Panels**  
See this [helpful guide](/guides/submit-vitals-via-fhir/) to walk you through creating a vital panel via FHIR.  
  - Vital sign panels and vital signs are both observations.  
    - Vital sign panels are the parent that "contain" the vital sign observations. The `hasMembers` attribute contains references to the child observations  
    - Each vital sign that is part of the panel links back to the parent Observation via the `derivedFrom` attribute.  
    - If a `derivedFrom` value is not included for a vital sign observation, then a new vital sign panel observation is created and will autofill the `derivedFrom` attribute field.  
  - Vital signs and their parent panel feed into our [Vitals command](https://canvas-medical.help.usepylon.com/articles/9426091672-command-vitals).  
**Note types**  
Most our FHIR endpoints insert commands into a Data Import Note type on the patient's timeline. With the release of [configurable note types](https://help.canvasmedical.com/articles/6785045644-appointment-event-note-types), if you create a new Note Type in Settings with **system = Canvas** and **code = VitalsImport** , then the Observation Create endpoint will always import into that note type instead.  
**Supported vital sign codes used in create**
vital sign | LOINC code | default unit | additional accepted units  
---|---|---|---  
vital sign panel | 85353-1 |  |   
blood pressure | 85354-9 | mmHg |   
weight | 29463-7 | oz | lb, kg  
height | 8302-2 | in | cm  
pulse rate | 8867-4 | bpm |   
body temperature | 8310-5 | °F |   
oxygen saturation (arterial)* | 2708-6 | % |   
oxygen saturation* | 59408-5 | % |   
respiration rate | 9279-1 | bpm |   
waist circumference | 56086-2 | cm | in  
note | 80339-5 |  |   
pulse rhythm | 8884-9 |  |   
*If an oxygen saturation vital sign is created, an oxygen saturation (arterial) vital sign code is also automatically generated.  
A vital sign code that is not listed in the table above is rejected with a 405 and the message `Sign is not supported by Canvas`. In particular, **supplemental oxygen (88658-0) cannot be created through this endpoint** — it can only be captured through the Vitals command in Canvas. Supplemental oxygen observations are still returned by read and search, where the value appears as a `valueCodeableConcept`.  
**Additional examples**
  - [Creating a vital panel](https://github.com/canvas-medical/canvas-fhir-example-requests/blob/main/Observation/Create%20Observation%20-%20panel.bru)
  - [Creating a vital sign with components (should only be used for blood pressure)](https://github.com/canvas-medical/canvas-fhir-example-requests/blob/main/Observation/Create%20Observation%20-%20w-%20components.bru)
  - [Creating a vital sign without components](https://github.com/canvas-medical/canvas-fhir-example-requests/blob/main/Observation/Create%20Observation%20-%20w-o%20components.bru)
### Attributes
resourceType 
string 
The FHIR Resource name.
status 
enum [ final | unknown | entered-in-error ] required
The status of the result value. Observations created via the FHIR API can only be `final`.
code 
json required
Describes what was observed.  
For create interactions, only vital sign LOINC codes are supported.
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string required
The code of the observation.
**Value Options Supported:**
  - 85353-1 (panel) 
  - 85354-9 (blood pressure) 
  - 29463-7 (weight) 
  - 8302-2 (height) 
  - 8867-4 (pulse rate) 
  - 8310-5 (body temperature) 
  - 2708-6 (oxygen saturation arterial) 
  - 59408-5 (oxygen saturation) 
  - 9279-1 (respiration rate) 
  - 56086-2 (waist circumference) 
  - 80339-5 (note) 
  - 8884-9 (pulse rhythm) 
display 
string required
The display name of the coding.
subject 
json required
Canvas Patient reference the Observation is for.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
effectiveDateTime 
datetime 
Clinically relevant time/time-period for observation.  
For an individual vital sign, if the effectiveDateTime differs from the panel time, it will be reflected in a read/search; however, you will not see the individual date in the UI, only the panel's datetime.  
If omitted from create, Canvas will save a default value of the current datetime.
performer 
array[json] 
Who is responsible for the observation
Click to view child attributes
reference 
string 
The reference string of the performer in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"` or `"Patient/a39cafb9d1b445be95a2e2548e12a787"`. Performer can be a Practitioner or a Patient.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "Patient").
valueQuantity 
json 
Actual result.  
This is used for vital observation that correspond with a numeric value. If this field is not provided or specifically the value attribute in the json is omitted, Canvas will interpret that as an empty value. A Read/Search of this observation will display the `dataAbsentReason` attribute.   
Currently supported numeric values are  
\- height  
\- weight  
\- waist circumference  
\- body temperature  
\- pulse rate  
\- oxygen saturation  
\- respiration rate A `valueQuantity` can also be used to represent a diagnostic score. Scores will have a unit of 'score'.
Click to view child attributes
value 
number required
Numerical value (with implicit precision).
unit 
string 
Unit representation. If omitted, it will default to the values in the table defined above. For the submitted `code`, only units from the table above can be sent. Sending a different unit will result in a 422 error.
valueString 
string 
Actual result.  
This is used for vital observation that correspond with a string value. If this field is not provided or specifically the value attribute in the json is omitted, Canvas will interpret that as an empty value. A Read/Search of this observation will display the `dataAbsentReason` attribute.   
Currently supported string values are   
\- **note** \- this is a free text comment field in the Canvas Vital Command   
\- **pulse rhythm** \- This is an enum in the Canvas Vital command. Values supported are **Regular** , **Irregularly Irregular** , **Regulary Irregular**. If one of these values is not provided, a 422 error will occur.   
\- **blood pressure** \- This is a string reprentation of the systolic and diastolic combined in the format `"100/80"`. If this valueString is not given, it will not appear correctly in the Canvas Vital Command.
hasMember 
array[json] 
Related Observation reference(s) that belongs to the Observation group/panel.  
Only need to supply this attribute in a Vital Sign Panel to specify specific child observations that are a part of the panel. In Canvas these will form the Vitals Command. This observation IDs can be found using the [Observation Search](/api/observation/#search).   
If a new vital sign panel is created and links pre-existing vital signs via the `hasMember` attribute, those linked observations will update their `derivedFrom` attribute to be set to the newly created vital sign panel.
Click to view child attributes
reference 
string required
The reference string of the child observation in the format of `"Observation/920807d3-034b-4423-a65b-980068cb4bd1"`.
type 
string 
Type the reference refers to (e.g. "Observation").
display 
string 
The coding display of the reference.
derivedFrom 
array[json] 
Related Observation resource that the Observation is made from.  
This attribute should only be used to link a vital sign to an existing "parent" vital sign panel. It ingests a reference to the vital sign panel's observation. This observation ID can be found using the [Observation Search](/api/observation/#search).  
If this field is omitted on a vital sign observation, a vital sign panel will automatically be created.   
It is important to note that each vital sign panel can only contain a single vital sign of each type. Adding a duplicate of a vital sign will result in a 422 error: "Vital sign reading already exists for the given reading".
Click to view child attributes
reference 
string required
The reference string of the child observation in the format of `"Observation/920807d3-034b-4423-a65b-980068cb4bd1"` or `"QuestionnaireResponse/0e34b12d-0494-4ade-9a51-aa12225dd959"`.
type 
string 
Type the reference refers to (e.g. "Observation", "QuestionnaireResponse").
component 
array[json] 
Component results  
This attribute is only used for blood pressure, as it has two components (systolic and diastolic).   
  - These components are added to a vital sign observation by including their `code` and `valueQuantity`.
  - The components are what will be stored in the database; however, they will not display on the UI. The `Observation.valueString` will be the attribute that displays on the UI.
  - The `valueQuantity` for the systolic component should match the first number in the blood pressure vital sign `valueQuantity`, where the `valueQuantity` of the diastole component should match the second number.
Click to view child attributes
code 
json required
Type of component observation (code / type).
Click to view child attributes
coding 
array[json] required
Code defined by a terminology system.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string required
The code of the observation.
**Value Options Supported:**
  - 8480-6 (systolic) 
  - 8462-4 (diastolic) 
display 
string required
The display name of the coding.
**Value Options Supported:**
  - Systolic blood pressure 
  - Diastolic blood pressure 
valueQuantity 
json 
Actual component result. Since this endpoint only supports blood pressure systolic/diastolic components, the units are already defaulted to `mmHg`.
Click to view child attributes
value 
number required
Numerical value (with implicit precision).
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Observation/{id}
#### Observation read
### Path Parameters
id required
string 
The unique identifier for the Observation   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the observation
status 
enum [ final | unknown | entered-in-error ] 
The status of the result value.
category 
array[json] 
Classifies the general type of observation being made.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/observation-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-category 
code 
string 
The code of the observation.
**Value Options Supported:**
  - vital-signs 
  - social-history 
  - imaging 
  - laboratory 
  - procedure 
  - survey 
  - exam 
  - therapy 
  - activity 
  - sdoh 
  - functional-status 
  - cognitive-status 
  - disability-status 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Vital Signs 
  - Social History 
  - Imaging 
  - Laboratory 
  - Procedure 
  - Survey 
  - Exam 
  - Therapy 
  - Activity 
  - SDOH 
  - Functional Status 
  - Cognitive Status 
  - Disability Status 
code 
json 
Describes what was observed.
Click to view child attributes
extension 
For observations that do not have an associated code (e.g Laboratory Observations), an extension will be displayed to denote an absent of a coding.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/data-absent-reason 
valueCode 
code 
The reason the Observation.coding attribute is missing.
**Value Options Supported:**
  - unsupported 
  - unknown 
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
code 
string 
The code of the observation.
**Value Options Supported:**
  - Any LOINC codes from Vital Panel or Vital Signs captured in the Observation Create / Vital Command 
  - 88658-0 (LOINC code for Supplemental Oxygen). This vital sign is read-only over FHIR: it can only be captured through the Vitals command, not created through this endpoint. Its value is returned as a `valueCodeableConcept` holding an answer code from LOINC answer list LL4908-1, rather than as a `valueQuantity` or `valueString` like the other vital signs. 
  - Any LOINC or SNOMED code from questions filled out through a Questionnaire, Structured Assessment, Physical Exam, Review of Systems 
  - Any code from a Questionnaire Scoring Result 
  - Pediatric Vital observations: 8306-3 (Body Length), 8289-1 (Head Occipital-Frontal Circumference Percentile), and 8287-5 (Head Circumference) 
  - 59576-9 (LOINC code for BMI for Age Percentile) 
  - 77606-2 (LOINC code for Weight-for-Length Percentile) 
  - Any LOINC codes from Lab Report Values captured 
display 
string 
The display name of the coding.
subject 
json 
Canvas Patient reference the Observation is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
effectiveDateTime 
datetime 
Clinically relevant time/time-period for observation.
effectivePeriod 
json 
Clinically relevant time/time-period for observation.  
The US Core Occupation profile presents the `effective` attribute as a time period with start and end datetimes.  
This attribute can only be read via FHIR, but not written.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary
end 
datetime 
End time with inclusive boundary, if not ongoing
performer 
array[json] 
Who is responsible for the observation
Click to view child attributes
reference 
string 
The reference string of the performer in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"` or `"Patient/a39cafb9d1b445be95a2e2548e12a787"`. Performer can be a Practitioner or a Patient.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "Patient").
issued 
datetime 
Date/Time this version was made available. It is the timestamp in Canvas when the observation was ingested.
valueQuantity 
json 
Actual result.   
Used for observations with numeric values like vitals, lab report values, any questionnaire result scoring programed in Canvas.
Click to view child attributes
value 
number 
Numerical value (with implicit precision).
unit 
string 
Unit representation.
system 
string 
System that defines coded unit form.
**Value Options Supported:**
  - http://unitsofmeasure.org 
code 
string 
Coded form of the unit may be shown.
**Value Options Supported:**
  - [lb_av] 
  - cm 
  - [in_i] 
  - [degF] 
  - mm[Hg] 
  - % 
  - /min 
  - kg/m2 
  - L/min 
valueString 
string 
Actual result.   
Used for observations containing text values like vitals that are strings (e.g Blood Pressure, notes, and pulse rhythm) and free text lab result values.
valueCodeableConcept 
json 
Actual result.  
Used for observations with a selected coding like Questionnaire Responses showing the answer to a specific question. This comes from Questionnaires, Structured Assessment, Physical Exam, and Review of Systems in Canvas.  
Also used for the **supplemental oxygen** vital sign (88658-0), whose value is an answer code from LOINC answer list LL4908-1 (`LA28684-1` Continuously depending on high oxygen flow, `LA28685-8` Continuously depending on low oxygen flow, `LA28686-6` Intermittent oxygen consumption). Supplemental oxygen is read-only over FHIR — it is not in the list of vital sign codes supported in create.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system. Codings are used when the Observation comes from a QuestionnaireResponse.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the observation.
display 
string 
The display name of the coding.
dataAbsentReason 
json 
Why the result is missing (if there is no `value[x]` section)
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string 
The code of the observation.
**Value Options Supported:**
  - not-performed 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Not Performed 
hasMember 
array[json] 
Related Observation reference(s) that belongs to the Observation group/panel.   
In Canvas, all the vital signs taken in a Vitals Command will be listed in this `hasMember` attribute.
Click to view child attributes
reference 
string 
The reference string of the child observation in the format of `"Observation/920807d3-034b-4423-a65b-980068cb4bd1"`.
type 
string 
Type the reference refers to (e.g. "Observation").
display 
string 
The coding display of the reference.
derivedFrom 
array[json] 
Related resource that the Observation is made from.  
For vital signs, the derivedFrom reference would be the observation that corresponds to the "parent" vital sign panel this observation is part of.   
For observations originating from a custom scoring of a Questionnaire or from answers filled out in Questionnaires, ROS, SA, or Physical Exams the `derivedFrom` attribute will be a reference to the associated QuestionnaireResponse record.
Click to view child attributes
reference 
string 
The reference string of the child observation in the format of `"Observation/920807d3-034b-4423-a65b-980068cb4bd1"` or `"QuestionnaireResponse/0e34b12d-0494-4ade-9a51-aa12225dd959"`.
type 
string 
Type the reference refers to (e.g. "Observation", "QuestionnaireResponse").
specimen 
json 
Reference to the Specimen resource that was used for this observation.  
This field is populated for laboratory observations that have an associated specimen from a lab order. The specimen reference includes the specimen's externally exposable ID.
Click to view child attributes
reference 
string 
The reference string of the specimen in the format of `"Specimen/0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d"`.
type 
string 
Type the reference refers to (e.g. "Specimen").
component 
array[json] 
Component results.   
Currently only used for blood pressure observations to display the systolic and diastolic components.
Click to view child attributes
code 
json 
Type of component observation (code / type).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string 
The code of the observation.
**Value Options Supported:**
  - 8480-6 (systolic) 
  - 8462-4 (diastolic) 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Systolic blood pressure 
  - Diastolic blood pressure 
valueCodeableConcept 
json 
Actual component result.  
Used when a component is represented by a value that is a reference to one or more terminologies or ontologies.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the observation.
display 
string 
The display name of the coding.
valueQuantity 
json 
Actual component result.
Click to view child attributes
value 
number 
Numerical value (with implicit precision).
unit 
string 
Unit representation.
**Value Options Supported:**
  - mmHg 
system 
string 
System that defines coded unit form.
**Value Options Supported:**
  - http://unitsofmeasure.org 
code 
string 
Coded form of the unit
**Value Options Supported:**
  - mm[Hg] 
valueString 
string 
Actual component result, when the value is non-numeric and not coded.
dataAbsentReason 
json 
Why the result is missing (if there is no `Component[x].value[y]` section)
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string 
The code of the observation.
**Value Options Supported:**
  - not-performed 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Not Performed 
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Observation
#### Observation search
### Query Parameters
****
_id 
string 
The Canvas resource id for the Observation
category 
string 
Classification of the type of observation. Filters by the code and/or system under `category.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g `http://terminology.hl7.org/CodeSystem/observation-category|vital-signs`).
code 
string 
The code of the observation type. Filters by the code and/or system under `code.coding` attribute. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g `http://loinc.org|85353-1`).
date 
date 
Filter by the `effectiveDateTime` attribute. See [Date Filtering](/api/date-filtering) for more information.
derived-from 
string 
A reference to a related measurement the observation is made from.   
Use this search parameter to find all observations of a specific vital panel or questionnaire response observations from the same interview.
**Search Values Supported:**
  - QuestionnaireResponse/{id}
  - Observation/{id}
patient 
string 
The patient reference associated to the observation in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The Canvas identifier of the observation
status 
enum [ final | unknown | entered-in-error ] 
The status of the result value.
category 
array[json] 
Classifies the general type of observation being made.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/observation-category 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-category 
code 
string 
The code of the observation.
**Value Options Supported:**
  - vital-signs 
  - social-history 
  - imaging 
  - laboratory 
  - procedure 
  - survey 
  - exam 
  - therapy 
  - activity 
  - sdoh 
  - functional-status 
  - cognitive-status 
  - disability-status 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Vital Signs 
  - Social History 
  - Imaging 
  - Laboratory 
  - Procedure 
  - Survey 
  - Exam 
  - Therapy 
  - Activity 
  - SDOH 
  - Functional Status 
  - Cognitive Status 
  - Disability Status 
code 
json 
Describes what was observed.
Click to view child attributes
extension 
For observations that do not have an associated code (e.g Laboratory Observations), an extension will be displayed to denote an absent of a coding.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/data-absent-reason 
valueCode 
code 
The reason the Observation.coding attribute is missing.
**Value Options Supported:**
  - unsupported 
  - unknown 
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
code 
string 
The code of the observation.
**Value Options Supported:**
  - Any LOINC codes from Vital Panel or Vital Signs captured in the Observation Create / Vital Command 
  - 88658-0 (LOINC code for Supplemental Oxygen). This vital sign is read-only over FHIR: it can only be captured through the Vitals command, not created through this endpoint. Its value is returned as a `valueCodeableConcept` holding an answer code from LOINC answer list LL4908-1, rather than as a `valueQuantity` or `valueString` like the other vital signs. 
  - Any LOINC or SNOMED code from questions filled out through a Questionnaire, Structured Assessment, Physical Exam, Review of Systems 
  - Any code from a Questionnaire Scoring Result 
  - Pediatric Vital observations: 8306-3 (Body Length), 8289-1 (Head Occipital-Frontal Circumference Percentile), and 8287-5 (Head Circumference) 
  - 59576-9 (LOINC code for BMI for Age Percentile) 
  - 77606-2 (LOINC code for Weight-for-Length Percentile) 
  - Any LOINC codes from Lab Report Values captured 
display 
string 
The display name of the coding.
subject 
json 
Canvas Patient reference the Observation is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
effectiveDateTime 
datetime 
Clinically relevant time/time-period for observation.
effectivePeriod 
json 
Clinically relevant time/time-period for observation.  
The US Core Occupation profile presents the `effective` attribute as a time period with start and end datetimes.  
This attribute can only be read via FHIR, but not written.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary
end 
datetime 
End time with inclusive boundary, if not ongoing
performer 
array[json] 
Who is responsible for the observation
Click to view child attributes
reference 
string 
The reference string of the performer in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"` or `"Patient/a39cafb9d1b445be95a2e2548e12a787"`. Performer can be a Practitioner or a Patient.
type 
string 
Type the reference refers to (e.g. "Practitioner" or "Patient").
issued 
datetime 
Date/Time this version was made available. It is the timestamp in Canvas when the observation was ingested.
valueQuantity 
json 
Actual result.   
Used for observations with numeric values like vitals, lab report values, any questionnaire result scoring programed in Canvas.
Click to view child attributes
value 
number 
Numerical value (with implicit precision).
unit 
string 
Unit representation.
system 
string 
System that defines coded unit form.
**Value Options Supported:**
  - http://unitsofmeasure.org 
code 
string 
Coded form of the unit may be shown.
**Value Options Supported:**
  - [lb_av] 
  - cm 
  - [in_i] 
  - [degF] 
  - mm[Hg] 
  - % 
  - /min 
  - kg/m2 
  - L/min 
valueString 
string 
Actual result.   
Used for observations containing text values like vitals that are strings (e.g Blood Pressure, notes, and pulse rhythm) and free text lab result values.
valueCodeableConcept 
json 
Actual result.  
Used for observations with a selected coding like Questionnaire Responses showing the answer to a specific question. This comes from Questionnaires, Structured Assessment, Physical Exam, and Review of Systems in Canvas.  
Also used for the **supplemental oxygen** vital sign (88658-0), whose value is an answer code from LOINC answer list LL4908-1 (`LA28684-1` Continuously depending on high oxygen flow, `LA28685-8` Continuously depending on low oxygen flow, `LA28686-6` Intermittent oxygen consumption). Supplemental oxygen is read-only over FHIR — it is not in the list of vital sign codes supported in create.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system. Codings are used when the Observation comes from a QuestionnaireResponse.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the observation.
display 
string 
The display name of the coding.
dataAbsentReason 
json 
Why the result is missing (if there is no `value[x]` section)
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string 
The code of the observation.
**Value Options Supported:**
  - not-performed 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Not Performed 
hasMember 
array[json] 
Related Observation reference(s) that belongs to the Observation group/panel.   
In Canvas, all the vital signs taken in a Vitals Command will be listed in this `hasMember` attribute.
Click to view child attributes
reference 
string 
The reference string of the child observation in the format of `"Observation/920807d3-034b-4423-a65b-980068cb4bd1"`.
type 
string 
Type the reference refers to (e.g. "Observation").
display 
string 
The coding display of the reference.
derivedFrom 
array[json] 
Related resource that the Observation is made from.  
For vital signs, the derivedFrom reference would be the observation that corresponds to the "parent" vital sign panel this observation is part of.   
For observations originating from a custom scoring of a Questionnaire or from answers filled out in Questionnaires, ROS, SA, or Physical Exams the `derivedFrom` attribute will be a reference to the associated QuestionnaireResponse record.
Click to view child attributes
reference 
string 
The reference string of the child observation in the format of `"Observation/920807d3-034b-4423-a65b-980068cb4bd1"` or `"QuestionnaireResponse/0e34b12d-0494-4ade-9a51-aa12225dd959"`.
type 
string 
Type the reference refers to (e.g. "Observation", "QuestionnaireResponse").
specimen 
json 
Reference to the Specimen resource that was used for this observation.  
This field is populated for laboratory observations that have an associated specimen from a lab order. The specimen reference includes the specimen's externally exposable ID.
Click to view child attributes
reference 
string 
The reference string of the specimen in the format of `"Specimen/0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d"`.
type 
string 
Type the reference refers to (e.g. "Specimen").
component 
array[json] 
Component results.   
Currently only used for blood pressure observations to display the systolic and diastolic components.
Click to view child attributes
code 
json 
Type of component observation (code / type).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string 
The code of the observation.
**Value Options Supported:**
  - 8480-6 (systolic) 
  - 8462-4 (diastolic) 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Systolic blood pressure 
  - Diastolic blood pressure 
valueCodeableConcept 
json 
Actual component result.  
Used when a component is represented by a value that is a reference to one or more terminologies or ontologies.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
code 
string 
The code of the observation.
display 
string 
The display name of the coding.
valueQuantity 
json 
Actual component result.
Click to view child attributes
value 
number 
Numerical value (with implicit precision).
unit 
string 
Unit representation.
**Value Options Supported:**
  - mmHg 
system 
string 
System that defines coded unit form.
**Value Options Supported:**
  - http://unitsofmeasure.org 
code 
string 
Coded form of the unit
**Value Options Supported:**
  - mm[Hg] 
valueString 
string 
Actual component result, when the value is non-numeric and not coded.
dataAbsentReason 
json 
Why the result is missing (if there is no `Component[x].value[y]` section)
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/data-absent-reason 
code 
string 
The code of the observation.
**Value Options Supported:**
  - not-performed 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Not Performed 
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Observation' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
          "resourceType": "Observation",
          "status": "final",
          "code": {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "29463-7",
                "display": "Weight"
              }
            ]
          },
          "subject": {
            "reference": "Patient/ee8672f3497e4a83937b9e71d0a704a5"
          },
          "effectiveDateTime": "2022-07-29T08:50:24.883809+00:00",
          "valueQuantity": {
            "value": "50",
            "unit": "kg"
          },
          "derivedFrom": [
            {
              "reference": "Observation/6173fbe8-110e-4a4a-9647-e949f7b1c35e",
              "type": "Observation"
            }
          ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Observation"
        payload = {
            "resourceType": "Observation",
            "status": "final",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "29463-7",
                  "display": "Weight"
                }
              ]
            },
            "subject": { "reference": "Patient/ee8672f3497e4a83937b9e71d0a704a5" },
            "effectiveDateTime": "2022-07-29T08:50:24.883809+00:00",
            "valueQuantity": { "value": "50", "unit": "lb" },
            "derivedFrom": [{ "reference": "Observation/6173fbe8-110e-4a4a-9647-e949f7b1c35e" }]
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Observation/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Observation/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Observation",
            "id": "43b74793-5de6-435a-871d-8ae2232f3aa0",
            "status": "final",
            "category": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                            "code": "vital-signs",
                            "display": "Vital Signs"
                        }
                    ]
                }
            ],
            "code": {
                "coding": [
                    {
                        "system": "http://loinc.org",
                        "code": "85353-1"
                    }
                ]
            },
            "subject": {
                "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
                "type": "Patient"
            },
            "effectiveDateTime": "2022-06-28T20:18:54.141759+00:00",
            "performer":
            [
                {
                    "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                    "type": "Practitioner"
                }
            ],
            "issued": "2022-06-28T20:43:10.465819+00:00",
            "dataAbsentReason": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                        "code": "not-performed",
                        "display": "Not Performed"
                    }
                ]
            },
            "hasMember": [
                {
                    "reference": "Observation/dd7f25f3-0fa6-4f15-9b8c-c61c24f139d8",
                    "type": "Observation",
                    "display": "Weight"
                },
                {
                    "reference": "Observation/3b96ab8b-aef6-4cbe-8ec5-b88c8e120e19",
                    "type": "Observation",
                    "display": "Body Temperature"
                },
                {
                    "reference": "Observation/201d4404-60c0-4f07-88c1-534456271a74",
                    "type": "Observation",
                    "display": "Blood Pressure"
                },
                {
                    "reference": "Observation/841187ae-0c35-4db7-8852-b5370e4a5c51",
                    "type": "Observation",
                    "display": "Pulse Rhythm"
                },
                {
                    "reference": "Observation/60e563bd-7848-487d-8852-c0db383dc115",
                    "type": "Observation",
                    "display": "Oxygen Saturation Arterial"
                },
                {
                    "reference": "Observation/cb8bca44-d0de-48b0-8786-6887a4b649ec",
                    "type": "Observation",
                    "display": "Height"
                },
                {
                    "reference": "Observation/b96e8bd4-1db9-46db-b292-e9a474bdca44",
                    "type": "Observation",
                    "display": "Waist Circumference"
                },
                {
                    "reference": "Observation/1e8b6774-82c3-4f0b-9b28-fca5fc17e8c9",
                    "type": "Observation",
                    "display": "Pulse"
                },
                {
                    "reference": "Observation/8642e444-53a6-4db8-a15f-17fdb2e01247",
                    "type": "Observation",
                    "display": "Respiration Rate"
                },
                {
                    "reference": "Observation/d0996ff1-643a-4711-88f8-2e303d208663",
                    "type": "Observation",
                    "display": "Note"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Observation resource 'a47c7b0ebbb442cdbc4adf259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Observation?category=vital-signs&patient=Patient/b60b818fad134c3095b34dd392be9533' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Observation?category=vital-signs&patient=Patient/b60b818fad134c3095b34dd392be9533"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 19,
            "link": [
                {
                    "relation": "self",
                    "url": "/Observation?patient=Patient%2Fb60b818fad134c3095b34dd392be9533&_count=20&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Observation?patient=Patient%2Fb60b818fad134c3095b34dd392be9533&_count=20&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Observation?patient=Patient%2Fb60b818fad134c3095b34dd392be9533&_count=20&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "378d88eb-cbfc-4668-a96e-c1e011f9f015",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "85353-1",
                                    "display": "Vital Signs Panel"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-09T18:35:35.633932+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:35:35.651181+00:00",
                        "dataAbsentReason": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "not-performed",
                                    "display": "Not Performed"
                                }
                            ]
                        },
                        "hasMember": [
                            {
                                "reference": "Observation/201d4404-60c0-4f07-88c1-534456271a74",
                                "type": "Observation",
                                "display": "Blood Pressure"
                            },
                            {
                                "reference": "Observation/60e563bd-7848-487d-8852-c0db383dc115",
                                "type": "Observation",
                                "display": "Oxygen Saturation Arterial"
                            },
                            {
                                "reference": "Observation/cb8bca44-d0de-48b0-8786-6887a4b649ec",
                                "type": "Observation",
                                "display": "Height"
                            },
                            {
                                "reference": "Observation/841187ae-0c35-4db7-8852-b5370e4a5c51",
                                "type": "Observation",
                                "display": "Pulse Rhythm"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "cb8bca44-d0de-48b0-8786-6887a4b649ec",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8302-2",
                                    "display": "Height"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-09T18:35:35.754424+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:35:35.756630+00:00",
                        "valueQuantity": {
                            "value": 69.0,
                            "unit": "in",
                            "system": "http://unitsofmeasure.org",
                            "code": "[in_i]"
                        },
                        "derivedFrom": [
                            {
                                "reference": "Observation/378d88eb-cbfc-4668-a96e-c1e011f9f015",
                                "type": "Observation"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "60e563bd-7848-487d-8852-c0db383dc115",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "2708-6",
                                    "display": "Oxygen Saturation Arterial"
                                },
                                {
                                    "system": "http://loinc.org",
                                    "code": "59408-5",
                                    "display": "Oxygen Saturation"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-09T18:35:35.744026+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:35:35.745602+00:00",
                        "valueQuantity": {
                            "value": 98.0,
                            "unit": "%",
                            "system": "http://unitsofmeasure.org",
                            "code": "%"
                        },
                        "derivedFrom": [
                            {
                                "reference": "Observation/378d88eb-cbfc-4668-a96e-c1e011f9f015",
                                "type": "Observation"
                            }
                        ],
                        "component": [
                            {
                                "code": {
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "3150-0",
                                            "display": "Inhaled oxygen concentration"
                                        }
                                    ]
                                },
                                "valueQuantity": {
                                    "value": 98.0,
                                    "unit": "%",
                                    "system": "http://unitsofmeasure.org",
                                    "code": "%"
                                }
                            },
                            {
                                "code": {
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "3151-8",
                                            "display": "Inhaled oxygen flow rate"
                                        }
                                    ]
                                },
                                "dataAbsentReason": {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                            "code": "not-performed",
                                            "display": "Not Performed"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "841187ae-0c35-4db7-8852-b5370e4a5c51",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8884-9",
                                    "display": "Pulse Rhythm"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-09T18:35:35.739851+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:35:35.741587+00:00",
                        "valueString": "Regular",
                        "derivedFrom": [
                            {
                                "reference": "Observation/378d88eb-cbfc-4668-a96e-c1e011f9f015",
                                "type": "Observation"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "201d4404-60c0-4f07-88c1-534456271a74",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "85354-9",
                                    "display": "Blood Pressure"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-09T18:35:35.714893+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:35:35.716508+00:00",
                        "valueString": "120/80 mmHg",
                        "derivedFrom": [
                            {
                                "reference": "Observation/378d88eb-cbfc-4668-a96e-c1e011f9f015",
                                "type": "Observation"
                            }
                        ],
                        "component": [
                            {
                                "code": {
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "8480-6",
                                            "display": "Systolic blood pressure"
                                        }
                                    ]
                                },
                                "valueQuantity": {
                                    "value": 120.0,
                                    "unit": "mmHg",
                                    "system": "http://unitsofmeasure.org",
                                    "code": "mm[Hg]"
                                }
                            },
                            {
                                "code": {
                                    "coding": [
                                        {
                                            "system": "http://loinc.org",
                                            "code": "8462-4",
                                            "display": "Diastolic blood pressure"
                                        }
                                    ]
                                },
                                "valueQuantity": {
                                    "value": 80.0,
                                    "unit": "mmHg",
                                    "system": "http://unitsofmeasure.org",
                                    "code": "mm[Hg]"
                                }
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "93d50727-307e-4be4-b4b3-fad266e22083",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "social-history",
                                        "display": "Social History"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "76503-2",
                                    "display": "HARK - Kick"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:34.594656+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:41:38.029091+00:00",
                        "valueCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "LA33-6",
                                    "display": "Yes"
                                }
                            ]
                        },
                        "derivedFrom": [
                            {
                                "reference": "QuestionnaireResponse/74b511d0-a112-48ff-9e03-ba5f103a2a15",
                                "type": "QuestionnaireResponse"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "b37b8285-b1e7-4298-9c25-a62b1303f799",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "social-history",
                                        "display": "Social History"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "76502-4",
                                    "display": "HARK - Rape"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:34.594656+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:41:38.024815+00:00",
                        "valueCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "LA33-6",
                                    "display": "Yes"
                                }
                            ]
                        },
                        "derivedFrom": [
                            {
                                "reference": "QuestionnaireResponse/74b511d0-a112-48ff-9e03-ba5f103a2a15",
                                "type": "QuestionnaireResponse"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "d3d10677-c211-4a04-ab8f-d5fe4b736bf8",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "social-history",
                                        "display": "Social History"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "76501-6",
                                    "display": "HARK - Afraid"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:34.594656+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:41:38.020391+00:00",
                        "valueCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "LA33-6",
                                    "display": "Yes"
                                }
                            ]
                        },
                        "derivedFrom": [
                            {
                                "reference": "QuestionnaireResponse/74b511d0-a112-48ff-9e03-ba5f103a2a15",
                                "type": "QuestionnaireResponse"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "77e9ef2c-f702-4cf7-ae6d-a093527a9727",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "social-history",
                                        "display": "Social History"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "76500-8",
                                    "display": "HARK - Humiliated"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:34.594656+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:41:38.012952+00:00",
                        "valueCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "LA33-6",
                                    "display": "Yes"
                                }
                            ]
                        },
                        "derivedFrom": [
                            {
                                "reference": "QuestionnaireResponse/74b511d0-a112-48ff-9e03-ba5f103a2a15",
                                "type": "QuestionnaireResponse"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "79e21363-d1e2-4be9-a9d0-2a737c595cd6",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "laboratory",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unsupported"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-03T07:00:00+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T20:11:12.198162+00:00",
                        "dataAbsentReason": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "not-performed",
                                    "display": "Not Performed"
                                }
                            ]
                        },
                        "hasMember": [
                            {
                                "reference": "Observation/13a6df29-a0c7-4233-a4e5-940c82f58006",
                                "type": "Observation",
                                "display": "Act.Prt.C Resist."
                            },
                            {
                                "reference": "Observation/84c34368-d839-4bb2-b967-787ecef5b595",
                                "type": "Observation",
                                "display": "Amended report:"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "84c34368-d839-4bb2-b967-787ecef5b595",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "laboratory",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "N/A",
                                    "display": "Amended report:"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-03T07:00:00+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T20:11:12.256507+00:00",
                        "valueString": "test"
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "13a6df29-a0c7-4233-a4e5-940c82f58006",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "laboratory",
                                        "display": "Laboratory"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "13590-5",
                                    "display": "Act.Prt.C Resist."
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-03T07:00:00+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T20:11:12.243418+00:00",
                        "specimen": {
                            "reference": "Specimen/0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d",
                            "type": "Specimen"
                        },
                        "valueQuantity": {
                            "value": 1.0,
                            "unit": "ratio",
                            "system": "http://unitsofmeasure.org"
                        }
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "f7370ea2-f44b-4f47-9ba1-073db8e6c365",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "survey",
                                        "display": "Survey"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "76499-3"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:34.594656+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-09T18:41:37.996595+00:00",
                        "valueQuantity": {
                            "value": 4.0,
                            "system": "http://unitsofmeasure.org"
                        },
                        "derivedFrom": [
                            {
                                "reference": "QuestionnaireResponse/74b511d0-a112-48ff-9e03-ba5f103a2a15",
                                "type": "QuestionnaireResponse"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "1397bed8-7bab-4fdf-b926-b7542ccfbef0",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "social-history",
                                        "display": "Social History"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8287-5",
                                    "display": "Head circumference (cm)"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:34.594656+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T18:58:45.819506+00:00",
                        "valueCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8287-5",
                                    "display": "20"
                                }
                            ]
                        },
                        "derivedFrom": [
                            {
                                "reference": "QuestionnaireResponse/82f09164-afa8-462c-88e0-552b89976613",
                                "type": "QuestionnaireResponse"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "221534cf-690f-4166-86f2-7f392edf4348",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "social-history",
                                        "display": "Social History"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8306-3",
                                    "display": "Body length (in)"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:34.594656+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T18:58:45.805651+00:00",
                        "valueCodeableConcept": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8306-3",
                                    "display": "30"
                                }
                            ]
                        },
                        "derivedFrom": [
                            {
                                "reference": "QuestionnaireResponse/82f09164-afa8-462c-88e0-552b89976613",
                                "type": "QuestionnaireResponse"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "84a41e03-34f2-414e-8bf8-c7fc8ee75c16",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8289-1",
                                    "display": "Head Occipital-frontal circumference Percentile"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:45.616779+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T18:58:45.781371+00:00",
                        "valueQuantity": {
                            "value": 90.0,
                            "unit": "%",
                            "system": "http://unitsofmeasure.org",
                            "code": "%"
                        },
                        "derivedFrom": [
                            {
                                "reference": "Observation/74c7bcd6-a229-4bef-82fa-b0fec3c0cc1a",
                                "type": "Observation"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "ab2cce20-4186-4ccd-bf7d-93009fbe7748",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8287-5",
                                    "display": "Head Circumference"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:45.616779+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T18:58:45.766580+00:00",
                        "valueQuantity": {
                            "value": 37.0,
                            "unit": "cm",
                            "system": "http://unitsofmeasure.org",
                            "code": "cm"
                        },
                        "derivedFrom": [
                            {
                                "reference": "Observation/74c7bcd6-a229-4bef-82fa-b0fec3c0cc1a",
                                "type": "Observation"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "d0bb3a0f-8925-4bb8-958a-af0d37b095ab",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "8306-3",
                                    "display": "Length"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:45.616779+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T18:58:45.751224+00:00",
                        "valueQuantity": {
                            "value": 20.0,
                            "unit": "in",
                            "system": "http://unitsofmeasure.org",
                            "code": "[in_i]"
                        },
                        "derivedFrom": [
                            {
                                "reference": "Observation/74c7bcd6-a229-4bef-82fa-b0fec3c0cc1a",
                                "type": "Observation"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Observation",
                        "id": "74c7bcd6-a229-4bef-82fa-b0fec3c0cc1a",
                        "status": "final",
                        "category": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                        "code": "vital-signs",
                                        "display": "Vital Signs"
                                    }
                                ]
                            }
                        ],
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "85353-1",
                                    "display": "Vital Signs Panel"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b60b818fad134c3095b34dd392be9533",
                            "type": "Patient"
                        },
                        "effectiveDateTime": "2024-04-08T18:58:45.616779+00:00",
                        "performer":
                        [
                            {
                                "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
                                "type": "Practitioner"
                            }
                        ],
                        "issued": "2024-04-08T18:58:45.629738+00:00",
                        "dataAbsentReason": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                    "code": "not-performed",
                                    "display": "Not Performed"
                                }
                            ]
                        },
                        "hasMember": [
                            {
                                "reference": "Observation/d0bb3a0f-8925-4bb8-958a-af0d37b095ab",
                                "type": "Observation",
                                "display": "Length"
                            },
                            {
                                "reference": "Observation/ab2cce20-4186-4ccd-bf7d-93009fbe7748",
                                "type": "Observation",
                                "display": "Head Circumference"
                            },
                            {
                                "reference": "Observation/84a41e03-34f2-414e-8bf8-c7fc8ee75c16",
                                "type": "Observation",
                                "display": "Head Occipital-frontal circumference Percentile"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/observation/


----- BEGIN PAGE https://docs.canvasmedical.com/api/organization/
### 
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-organization.html>   
Organizations come from four different Canvas data types: Organizations, Vendors, Insurers, and Service Providers. Organizations, Vendors, and Insurers can be managed in Canvas Settings. Service Providers are created automatically when an external provider is referenced, such as when a referral or imaging order is placed, when an external member is added to a patient's Care Team, or when an inbound fax is received. They appear as Organization participants on patient [Care Teams](/api/careteam). FHIR Organizations created by Insurers in Canvas are useful in the [FHIR Coverage](/api/coverage) payor attribute.
### Endpoints
get /Organization/{id} get /Organization
get
/Organization/{id}
#### Organization read
Read an Organization resource.
### Path Parameters
id required
string 
The unique identifier for the Organization   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Organization.
identifier 
array[json] 
Identifies this organization across multiple systems.  
When relevant, group NPI values, taxonomy ids, and tax ids will be found for relevant organizations. Identifiers for vendors and transactors, such as insurance payor values, are not yet supported.
Click to view child attributes
type 
array 
Description of identifier.   
Currently only type will appear for Organizations with a Tax ID.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0203 
code 
string 
The code identifying the identifier type.
**Value Options Supported:**
  - TAX 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Tax ID number 
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - urn:oid:2.16.840.1.113883.4.4 (for Tax ID) 
  - http://hl7.org/fhir/sid/us-npi (for NPI) 
  - http://nucc.org/provider-taxonomy (for Provider Taxonomy) 
value 
string 
The value that is unique.
type 
array[json] 
The kind of organization.   
Maps Canvas data types to the `http://terminology.hl7.org/CodeSystem/organization-type` value set:  
`prov` — ServiceProviders and Organizations  
`pay` — Transactors/Insurers  
`other` — the Canvas Vendor
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/organization-type 
code 
string 
The code for the organization type.
**Value Options Supported:**
  - prov (Healthcare Provider)
  - pay (Payer)
  - other (Other)
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the type.
**Value Options Supported:**
  - Healthcare Provider 
  - Payer 
  - Other 
active 
boolean 
Whether the organization's record is still in active use.
name 
string 
Name used for the organization.
telecom 
array[json] 
A contact detail for the organization (phone / email / fax).
Click to view child attributes
system 
enum [ phone | fax | email | pager | other ] 
Telecommunications form for contact point - what communications system is required to make use of the contact.
value 
string 
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
use 
enum [ work | temp | old | mobile ] 
Identifies the purpose for the contact point.
address 
array[json] 
An address for the organization. This will include both physical and billing addresses, when available.
Click to view child attributes
use 
enum [ work | temp | old | billing ] 
Defines the purpose of this address.
type 
enum [ both | physical | postal ] 
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses).
line 
array[string] 
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.  
The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
The name of the city, town, suburb, village or other community or delivery center.
state 
string 
Two-letter state abbreviation of the address.
postalCode 
string 
The 5-digit postal code of the address.
country 
string 
Specifies the country in which the organization's address is located.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Organization
#### Organization search
Search for Organization resources.
### Query Parameters
****
_id 
string 
The identifier of the Organization
address 
string 
A server defined search that may match any of the string fields in the Address, including line, city, state, and/or postalCode
name 
string 
A portion of the organization's name
type 
token 
A code for the type of organization.
**Search Values Supported:**
  - prov
  - pay
  - other
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Organization.
identifier 
array[json] 
Identifies this organization across multiple systems.  
When relevant, group NPI values, taxonomy ids, and tax ids will be found for relevant organizations. Identifiers for vendors and transactors, such as insurance payor values, are not yet supported.
Click to view child attributes
type 
array 
Description of identifier.   
Currently only type will appear for Organizations with a Tax ID.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v2-0203 
code 
string 
The code identifying the identifier type.
**Value Options Supported:**
  - TAX 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Tax ID number 
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - urn:oid:2.16.840.1.113883.4.4 (for Tax ID) 
  - http://hl7.org/fhir/sid/us-npi (for NPI) 
  - http://nucc.org/provider-taxonomy (for Provider Taxonomy) 
value 
string 
The value that is unique.
type 
array[json] 
The kind of organization.   
Maps Canvas data types to the `http://terminology.hl7.org/CodeSystem/organization-type` value set:  
`prov` — ServiceProviders and Organizations  
`pay` — Transactors/Insurers  
`other` — the Canvas Vendor
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/organization-type 
code 
string 
The code for the organization type.
**Value Options Supported:**
  - prov (Healthcare Provider)
  - pay (Payer)
  - other (Other)
display 
string 
The display name of the coding.
text 
string 
Plain text representation of the type.
**Value Options Supported:**
  - Healthcare Provider 
  - Payer 
  - Other 
active 
boolean 
Whether the organization's record is still in active use.
name 
string 
Name used for the organization.
telecom 
array[json] 
A contact detail for the organization (phone / email / fax).
Click to view child attributes
system 
enum [ phone | fax | email | pager | other ] 
Telecommunications form for contact point - what communications system is required to make use of the contact.
value 
string 
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
use 
enum [ work | temp | old | mobile ] 
Identifies the purpose for the contact point.
address 
array[json] 
An address for the organization. This will include both physical and billing addresses, when available.
Click to view child attributes
use 
enum [ work | temp | old | billing ] 
Defines the purpose of this address.
type 
enum [ both | physical | postal ] 
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses).
line 
array[string] 
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.  
The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
The name of the city, town, suburb, village or other community or delivery center.
state 
string 
Two-letter state abbreviation of the address.
postalCode 
string 
The 5-digit postal code of the address.
country 
string 
Specifies the country in which the organization's address is located.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Organization/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Organization/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Organization",
            "id": "192cf534-fc40-4c68-a233-062807338635",
            "identifier": [
                {
                    "system": "http://hl7.org/fhir/sid/us-npi",
                    "value": "1111111112"
                },
                {
                    "system": "http://nucc.org/provider-taxonomy",
                    "value": "207Q00000X"
                },
                {
                    "type": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                "code": "TAX",
                                "display": "Tax ID number"
                            }
                        ]
                    },
                    "system": "urn:oid:2.16.840.1.113883.4.4",
                    "value": "123456789"
                }
            ],
            "type": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                            "code": "prov",
                            "display": "Healthcare Provider"
                        }
                    ],
                    "text": "Healthcare Provider"
                }
            ],
            "active": true,
            "name": "Canvas Training Organization",
            "telecom": [
                {
                    "system": "fax",
                    "value": "2314217892",
                    "use": "work"
                },
                {
                    "system": "email",
                    "value": "example@example.com",
                    "use": "work"
                },
                {
                    "system": "phone",
                    "value": "9567768088",
                    "use": "work"
                }
            ],
            "address": [
                {
                    "use": "work",
                    "type": "both",
                    "line": [
                        "3300 Washtenaw Avenue, Suite 227"
                    ],
                    "city": "Amherst",
                    "state": "MA",
                    "postalCode": "01002",
                    "country": "United States"
                },
                {
                    "use": "billing",
                    "type": "both",
                    "line": [
                        "1 Billing Lane"
                    ],
                    "city": "NY",
                    "state": "NY",
                    "postalCode": "11111",
                    "country": "USA"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Organization resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Organization?name=Canvas' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Organization?name=Canvas"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 2,
            "link": [
                {
                    "relation": "self",
                    "url": "/Organization?name=Canvas&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Organization?name=Canvas&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Organization?name=Canvas&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Organization",
                        "id": "00000000-0000-0000-0002-000000000000",
                        "type": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                                        "code": "other",
                                        "display": "Other"
                                    }
                                ],
                                "text": "Other"
                            }
                        ],
                        "active": true,
                        "name": "Canvas Medical",
                        "telecom": [
                            {
                                "system": "phone",
                                "value": "8003701416",
                                "use": "work"
                            },
                            {
                                "system": "email",
                                "value": "example@canvasmedical.com",
                                "use": "work"
                            }
                        ],
                        "address": [
                            {
                                "use": "work",
                                "type": "both",
                                "line": [
                                    "2037 Irving Street",
                                    "Suite 228"
                                ],
                                "city": "San Francisco",
                                "state": "CA",
                                "postalCode": "94122"
                            }
                        ]
                    }
                },
                {
                    "resource": {
                        "resourceType": "Organization",
                        "id": "192cf534-fc40-4c68-a233-062807338635",
                        "identifier": [
                            {
                                "system": "http://hl7.org/fhir/sid/us-npi",
                                "value": "1111111112"
                            },
                            {
                                "system": "http://nucc.org/provider-taxonomy",
                                "value": "207Q00000X"
                            },
                            {
                                "type": {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                            "code": "TAX",
                                            "display": "Tax ID number"
                                        }
                                    ]
                                },
                                "system": "urn:oid:2.16.840.1.113883.4.4",
                                "value": "123456789"
                            }
                        ],
                        "type": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                                        "code": "prov",
                                        "display": "Healthcare Provider"
                                    }
                                ],
                                "text": "Healthcare Provider"
                            }
                        ],
                        "active": true,
                        "name": "Canvas Training Organization",
                        "telecom": [
                            {
                                "system": "fax",
                                "value": "2314217892",
                                "use": "work"
                            },
                            {
                                "system": "email",
                                "value": "example@example.com",
                                "use": "work"
                            },
                            {
                                "system": "phone",
                                "value": "9567768088",
                                "use": "work"
                            }
                        ],
                        "address": [
                            {
                                "use": "work",
                                "type": "both",
                                "line": [
                                    "3300 Washtenaw Avenue, Suite 227"
                                ],
                                "city": "Amherst",
                                "state": "MA",
                                "postalCode": "01002",
                                "country": "United States"
                            },
                            {
                                "use": "billing",
                                "type": "both",
                                "line": [
                                    "1 Billing Lane"
                                ],
                                "city": "NY",
                                "state": "NY",
                                "postalCode": "11111",
                                "country": "USA"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/organization/


----- BEGIN PAGE https://docs.canvasmedical.com/api/pagination/
Most endpoints that perform search operations support pagination. For these endpoints, search results are paginated by default, with a `links` section as defined [by FHIR](http://hl7.org/fhir/R4/http.html#paging). The links include urls for `self`, `first`, `next`, and `last` as needed for the searchset. Clients that want all results will need to make use of these links to page through the data. Pagination links will not be provided for an empty result set. A tip when traversing through the pages, if a `next` relation is not in the links list, you are on the last page!
There is a maximum page size (`_count`) that is enforced by the server. This value is at 100 at the time of writing, but can change without warning. Clients must use the links in a search bundle to paginate after an initial search request is sent. When no count is specified in a search, it will default to 10.
In this example, `entry` contains 10 Observation resources - following the relative link marked as `next` returns the remaining 9.
    ```json
    {
        "resourceType": "Bundle",
        "type": "searchset",
        "total": 19,
        "link": [
            {
                "relation": "self",
                "url": "/Observation?_count=10&_offset=0"
            },
            {
                "relation": "first",
                "url": "/Observation?_count=10&_offset=0"
            },
            {
                "relation": "next",
                "url": "/Observation?_count=10&_offset=10"
            },
            {
                "relation": "last",
                "url": "/Observation?_count=10&_offset=10"
            }
        ],
        "entry": [
            {
                "resource": {
                    "resourceType": "Observation",
    ```
----- END PAGE https://docs.canvasmedical.com/api/pagination/


----- BEGIN PAGE https://docs.canvasmedical.com/api/patient/
### 
Demographics and other administrative information about an individual or animal receiving care or other health-related services.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html>  
Canvas supports a number of FHIR extensions on this resource. See the `extension` attribute below for the full list of supported extension URLs and their value shapes. The `birthsex` extension is **required** on create and update.
**Related guides:**
  - [Testing Pharmacy Workflows in a Staging Environment](/guides/pharmacy-staging-testing/)
### Endpoints
post /Patient get /Patient/{id} put /Patient/{id} get /Patient
post
/Patient
#### Patient create
On success, the new Patient's identifier is returned in the `Location` header of the response. The patient record can be viewed in Canvas at _https:// <instance>.canvasmedical.com/patient/<id>_.   
Most fields populated through this endpoint will display and be editable on the Patient profile page.
### Attributes
resourceType 
string required
The FHIR Resource name.
extension 
array[json] required
Canvas-supported FHIR extensions on this resource. Each entry has a `url` identifying the extension, plus either a `valueX` field or — for compound extensions (**race** , **ethnicity** , **tribal-affiliation** , **preferred-pharmacy**) — a nested `extension` array carrying the value. The `url` is matched as an exact string.   
The **birthsex** extension (`http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex`) is **required** on create and update.
Click to view child attributes
url 
string required
Identifies the extension. See the value-field descriptions below for which `url` pairs with which `valueX` (or nested `extension`) shape.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex (Required. Patient's sex assigned at birth, per ONC; aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex (Documented sex, distinct from sex at birth.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity (Gender the patient identifies as. Overrides the root gender field when provided.)
  - http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation (Patient's sexual orientation.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race (Patient's races. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity (Patient's ethnicities. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation (Tribe or band the patient associates with. Compound — uses nested extension.)
  - http://hl7.org/fhir/StructureDefinition/tz-code (Patient's timezone.)
  - http://schemas.canvasmedical.com/fhir/extensions/clinical-note (Free-text note shown under the patient's name on the clinical chart.)
  - http://schemas.canvasmedical.com/fhir/extensions/administrative-note (Free-text note shown under the patient's name on the administrative profile.)
  - http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy (Patient's preferred pharmacy. Compound — multiple allowed; one may be marked default.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider (Default Practitioner used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-location (Default Location used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/business-line (Business line the patient belongs to. Requires Business Line functionality on the instance.)
valueCode 
string 
Used by extensions whose value is a single code.   
**birthsex** — required when this extension is included.   
Code | Meaning  
---|---  
`M` | Male  
`F` | Female  
`OTH` | Other  
`UNK` | Unknown  
**sex**   
Code | Meaning  
---|---  
`184115007` | Patient sex unknown  
`248152002` | Female  
`248153007` | Male  
`33791000087105` | Identifies as nonbinary gender  
`asked-declined` | Asked but declined  
**sexual-orientation**   
Code | Meaning  
---|---  
`20430005` | Straight or heterosexual  
`38628009` | Lesbian, gay or homosexual  
`42035005` | Bisexual  
`OTH` | Something else, please describe  
`UNK` | Don't know  
`ASKU` | Choose not to disclose  
**tz-code** — any valid timezone code from the [FHIR timezone ValueSet](http://build.fhir.org/valueset-timezones.html), e.g., `America/New_York`.
valueString 
string 
Used by free-text extensions:   
  - **clinical-note** — displayed under the patient's name on the clinical chart. - **administrative-note** — displayed under the patient's name on the administrative profile.
valueId 
string 
Used by the **business-line** extension. The value is the `externallyExposableId` of the business line in Canvas.
valueCodeableConcept 
json 
Used by the **genderIdentity** extension. When this extension is provided, it overrides the root `gender` field.
Click to view child attributes
coding 
array[json] required
Exactly one coding entry is allowed.
Click to view child attributes
system 
string required
**Value Options Supported:**
  - http://snomed.info/sct 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string required
Gender identity code.
**Value Options Supported:**
  - 446151000124109 (Identifies as male gender)
  - 446141000124107 (Identifies as female gender)
  - 407377005 (Female-to-male transsexual)
  - 407376001 (Male-to-female transsexual)
  - 446131000124102 (Identifies as non-conforming gender)
  - OTH (Other)
  - ASKU (Asked but unknown)
display 
string 
Representation defined by the system.
text 
string 
valueReference 
json 
Used by **patient-default-provider** (must reference a Practitioner) and **patient-default-location** (must reference a Location). Both set the default used for eligibility checks.
Click to view child attributes
reference 
string required
Reference string in the form `Practitioner/{id}` or `Location/{id}`.
type 
string 
Resource type the reference points to.
**Value Options Supported:**
  - Practitioner 
  - Location 
extension 
array[json] 
Used by compound extensions whose value is itself a list of extensions. The shape of each inner entry depends on the outer `url`:   
**us-core-race** / **us-core-ethnicity** — one or more inner extensions with `url`: `ombCategory`, `detailed`, or `text`. For `ombCategory` / `detailed`, provide a `valueCoding`. For `text`, provide a `valueString`.   
**us-core-tribal-affiliation** — exactly one inner extension with `url`: `tribalAffiliation` and a `valueCodeableConcept` containing one or more codings (each requires `system`, `code`, and `display`).   
**preferred-pharmacy** — one inner extension with `url`: `ncpdp-id` is **required** ; the NCPDP number goes in `valueIdentifier.value` (must be exactly **7 digits** , left-padded with zeros). Optional inner extensions: `default` (boolean — at most one preferred pharmacy per patient may be set to `true`), `name`, `phone-number`, `address`, `fax-number`, `specialty_type` (each `valueString`).
Click to view child attributes
url 
string required
Identifies the inner extension. See the parent description above for which value applies to which compound extension.
**Value Options Supported:**
  - ombCategory (race / ethnicity — coded category (with valueCoding).)
  - detailed (race / ethnicity — detailed coded value (with valueCoding).)
  - text (race / ethnicity — free-text representation (with valueString).)
  - tribalAffiliation (tribal-affiliation — wraps the codings (with valueCodeableConcept).)
  - ncpdp-id (preferred-pharmacy — required. Pharmacy NCPDP id (with valueIdentifier).)
  - default (preferred-pharmacy — marks this pharmacy as the default (with valueBoolean).)
  - name (preferred-pharmacy — pharmacy name (with valueString).)
  - phone-number (preferred-pharmacy — pharmacy phone number (with valueString).)
  - address (preferred-pharmacy — pharmacy address (with valueString).)
  - fax-number (preferred-pharmacy — pharmacy fax (with valueString).)
  - specialty_type (preferred-pharmacy — pharmacy specialty (with valueString).)
valueCoding 
json 
For race / ethnicity `ombCategory` and `detailed` inner extensions.
Click to view child attributes
system 
string required
For known race / ethnicity codes use the OID; for `ASKU` use the v3-NullFlavor system.
**Value Options Supported:**
  - urn:oid:2.16.840.1.113883.6.238 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string required
Race or ethnicity code from the [CDC Race and Ethnicity CodeSystem](https://hl7.org/fhir/us/core/STU3.1.1/CodeSystem-cdcrec.html). Example race codes — `2131-1` (Other Race), `2106-3` (White). Example ethnicity codes — `2186-5` (Not Hispanic or Latino), `2135-2` (Hispanic or Latino).
display 
string 
valueCodeableConcept 
json 
For the **tribal-affiliation** inner extension. Contains a `coding` list with at least one entry; each coding requires `system`, `code`, and `display`.
Click to view child attributes
coding 
array[json] required
Click to view child attributes
system 
string required
Typically `http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS`.
code 
string required
display 
string required
valueIdentifier 
json 
For the **preferred-pharmacy** `ncpdp-id` inner extension.
Click to view child attributes
value 
string required
NCPDP identifier — must be **exactly 7 digits** , left-padded with zeros if needed.
system 
string required
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber 
valueBoolean 
boolean 
For the **preferred-pharmacy** `default` inner extension. At most one preferred-pharmacy entry per patient may be set to true.
valueString 
string 
Used in two contexts:   
• For the **race** / **ethnicity** `text` inner extension — a free-text representation of the race or ethnicity.   
• For the **preferred-pharmacy** metadata inner extensions (`name`, `phone-number`, `address`, `fax-number`, `specialty_type`) — free-text values about the pharmacy.
identifier 
array[json] 
External identifiers for this patient. None of these identifiers are surfaced on the patient chart, but they may help you correlate the Canvas patient with records in your own systems.
The MRN is auto-issued by Canvas; do not include it on create.
Click to view child attributes
use 
enum [ usual | official | temp | secondary | old ] 
Purpose of this identifier. Defaults to **usual** if omitted.
system 
string required
Free-text namespace for the value (e.g., "HealthCo", or a URL).
value 
string required
The identifier value. Must be 1–255 characters.
period 
json 
Validity window for this identifier. End-before-start is not validated.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD). Defaults to **1970-01-01** if omitted.
end 
date 
Inclusive end date (YYYY-MM-DD). Defaults to **2100-12-31** if omitted.
active 
boolean 
Whether the patient is active in the healthcare system. Defaults to `true` if omitted on create.
name 
array[json] required
One or more names for the patient. At least one entry is required, and exactly one entry must have `use`: **official** — that entry determines the patient's first/middle/last/prefix/suffix shown across the Canvas UI.   
Additional entries with `use`: **nickname** , **maiden** , or **old** are accepted: the first item in the `given` list of a **nickname** entry is stored as the patient's preferred name. **maiden** and **old** entries are stored but not displayed in the Canvas UI. Entries with any other `use` value are ignored.   
In the Canvas UI, patients display as `first last suffix (nickname)`, and search supports first, middle, last, suffix, and nickname.
Click to view child attributes
use 
enum [ official | nickname | old | maiden ] required
At least one entry with `use`: **official** is required. See the parent description for how each accepted value is handled.
family 
string required
Family name (often called 'Surname'). Required on the **official** entry to populate the patient's last name.
given 
array[string] required
Given names. The first item populates the patient's first name; remaining items are joined with a space and stored as the middle name.   
For a **nickname** entry, only the first item is read and stored as the patient's preferred name. Surrounding whitespace is trimmed, and a value that is empty or whitespace-only is stored as an empty preferred name.
prefix 
array[string] 
Parts that come before the name (e.g., "Dr.", "Mr."). Stored but not displayed in the Canvas UI.
suffix 
array[string] 
Parts that come after the name (e.g., "Jr.", "III"). Surfaced in the Canvas UI.
period 
json 
Validity window for this name.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD).
end 
date 
Inclusive end date (YYYY-MM-DD).
telecom 
array[json] 
Patient contact points (phone / email / fax / etc.).   
Phone and email entries are surfaced in the Canvas UI. Other systems are accepted and stored but are not displayed.
Click to view child attributes
extension 
array[json] 
Optional flags about the contact point. The `has-consent` extension records that the patient has consented to receive messages at this contact point — set the `url` to **http://schemas.canvasmedical.com/fhir/extensions/has-consent** with `valueBoolean: true`.   
**Note:** Setting `has-consent` here does not send a verification email or text as the Canvas UI does — it bypasses verification and marks the contact point as verified.
Click to view child attributes
url 
string required
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/has-consent 
valueBoolean 
boolean required
system 
enum [ phone | fax | email | pager | url | sms | other ] required
Telecommunications form. `url` is stored internally as **other** , and `sms` is stored as **phone**.
value 
string required
The contact point value (phone number, email address, etc.).
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point. Defaults to **home** if omitted.
rank 
integer 
Preferred order across contact points of the same `system`. Defaults to **1**.
gender 
enum [ male | female | other | unknown ] required
Maps to the gender identity field in the Canvas UI. See the [administrative gender ValueSet](https://hl7.org/fhir/R4/valueset-administrative-gender.html).   
**unknown** displays as "choose not to disclose" on the patient chart. **other** displays as "Additional gender category or other, please specify".   
**Note:** If the `genderIdentity` extension is also provided, it overrides this field.
birthDate 
date required
Patient's date of birth, formatted **YYYY-MM-DD**.   
Canvas also accepts partial dates: **YYYY-MM** defaults to the 1st of the month, and **YYYY** defaults to January 1st.
deceasedDateTime 
datetime 
Date/time the patient died. Mutually exclusive with `deceasedBoolean` — provide one or the other.
deceasedBoolean 
boolean 
Whether the patient is deceased. Use when an exact date/time isn't known.
address 
array[json] 
Address(es) for the patient.
Click to view child attributes
use 
enum [ home | work | temp | old ] 
Defaults to **home** if omitted.
type 
enum [ both | physical | postal ] 
Defaults to **both** if omitted.
line 
array[string] 
First item populates address line 1; remaining items are concatenated as address line 2.
city 
string 
City of the address.
state 
string 
2-letter state abbreviation.
postalCode 
string 
5-digit postal code.
country 
string 
ISO 3166 2-letter country code. Defaults to **us**.
period 
json 
Validity window for this address.
Click to view child attributes
start 
date 
Inclusive start date.
end 
date 
Inclusive end date.
photo 
array[json] 
Patient photo. Displayed as the avatar in the Canvas UI.
Click to view child attributes
data 
string 
Base64-encoded image content. Use on create or update to upload a photo.
contact 
array[json] 
Contact parties (e.g., guardian, partner, friend, emergency contact) for the patient. Contact details display on the Patient profile page in the Canvas UI.
Click to view child attributes
relationship 
array[json] 
Codings describing the relationship of the contact to the patient. Codings can come from the standard `v3-RoleCode` system or from your instance's [configurable contact categories](https://help.canvasmedical.com/articles/8258338559-contact-categories), including the built-in **Emergency contact** category (`code`: `EMC`). Multiple codings can be combined on a single relationship to capture, e.g., both a familial relationship (`SPS` = spouse) and a contact-category role (`EMC` = emergency contact).
Click to view child attributes
coding 
array[json] 
Code(s) defined by a terminology system.
Click to view child attributes
system 
string required
The system URL of the coding. Use **http://terminology.hl7.org/CodeSystem/v3-RoleCode** for relationship-type codings from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), or **http://schemas.canvasmedical.com/fhir/contact-category** for Canvas's configurable contact categories.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-RoleCode 
  - http://schemas.canvasmedical.com/fhir/contact-category 
code 
string required
The code of the relationship or contact category.   
For the `v3-RoleCode` system, values come from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html).   
For the `contact-category` system, values are the codes configured under [Contact Categories](https://help.canvasmedical.com/articles/8258338559-contact-categories) on your instance — for example, `EMC` (Emergency contact), `ARI` (Authorized for release of information), `POA` (Power of attorney).
display 
string 
Human-readable name of the coding.
name 
json required
A name for the contact.   
Canvas only stores `name.text`. The structured sub-fields (`family`, `given`, `prefix`, `suffix`) are populated on read **only when the contact is itself a Canvas patient** , and are derived from that patient's record — they are not accepted on create or update.
Click to view child attributes
text 
string required
Free-text representation of the contact's full name. The only name field stored for a non-patient contact.
telecom 
array[json] 
Contact points for this contact.   
Canvas stores at most one phone and one email per contact: the **first** entry with `system`: **phone** is stored as the contact's phone number, and the **first** entry with `system`: **email** is stored as the email. Entries with any other `system` value are ignored.
Click to view child attributes
system 
enum [ phone | fax | email | pager | url | sms | other ] required
Only `phone` and `email` are stored on the contact; other values are ignored.
value 
string required
The contact point value.   
For `system: phone`, the value must be **exactly 10 digits** with no other characters (no dashes, spaces, or country code). Phone values that don't match are rejected.
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point.
communication 
array[json] 
Languages used to communicate with the patient.
Click to view child attributes
language 
json 
A language usable for communicating with the patient. See [Common Languages](https://hl7.org/fhir/R4/valueset-languages.html) (preferred) or [AllLanguages](https://hl7.org/fhir/R4/valueset-all-languages.html).
Click to view child attributes
coding 
array[json] 
Exactly one coding entry is allowed.
Click to view child attributes
system 
string required
**Value Options Supported:**
  - urn:ietf:bcp:47 
  - http://hl7.org/fhir/ValueSet/all-languages 
code 
string required
BCP-47 language code (e.g., `en`).
display 
string required
Human-readable language name (e.g., `English`).
text 
string 
Plain-text representation of the language.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Patient/{id}
#### Patient read
### Path Parameters
id required
string 
The unique identifier for the Patient   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
Canvas-issued unique identifier (UUID) for this Patient. It is the same id that appears in the URL of the patient's chart.
text 
json 
A human-readable narrative summarizing the resource. Generated by Canvas; not accepted on create or update.
extension 
array[json] 
Canvas-supported FHIR extensions on this resource. Each entry has a `url` identifying the extension, plus either a `valueX` field or — for compound extensions (**race** , **ethnicity** , **tribal-affiliation** , **preferred-pharmacy**) — a nested `extension` array carrying the value. The `url` is matched as an exact string.   
The **birthsex** extension (`http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex`) is **required** on create and update.
Click to view child attributes
url 
string 
Identifies the extension. See the value-field descriptions below for which `url` pairs with which `valueX` (or nested `extension`) shape.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex (Required. Patient's sex assigned at birth, per ONC; aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex (Documented sex, distinct from sex at birth.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity (Gender the patient identifies as. Overrides the root gender field when provided.)
  - http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation (Patient's sexual orientation.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race (Patient's races. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity (Patient's ethnicities. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation (Tribe or band the patient associates with. Compound — uses nested extension.)
  - http://hl7.org/fhir/StructureDefinition/tz-code (Patient's timezone.)
  - http://schemas.canvasmedical.com/fhir/extensions/clinical-note (Free-text note shown under the patient's name on the clinical chart.)
  - http://schemas.canvasmedical.com/fhir/extensions/administrative-note (Free-text note shown under the patient's name on the administrative profile.)
  - http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy (Patient's preferred pharmacy. Compound — multiple allowed; one may be marked default.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider (Default Practitioner used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-location (Default Location used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/business-line (Business line the patient belongs to. Requires Business Line functionality on the instance.)
valueCode 
string 
Used by extensions whose value is a single code.   
**birthsex** — required when this extension is included.   
Code | Meaning  
---|---  
`M` | Male  
`F` | Female  
`OTH` | Other  
`UNK` | Unknown  
**sex**   
Code | Meaning  
---|---  
`184115007` | Patient sex unknown  
`248152002` | Female  
`248153007` | Male  
`33791000087105` | Identifies as nonbinary gender  
`asked-declined` | Asked but declined  
**sexual-orientation**   
Code | Meaning  
---|---  
`20430005` | Straight or heterosexual  
`38628009` | Lesbian, gay or homosexual  
`42035005` | Bisexual  
`OTH` | Something else, please describe  
`UNK` | Don't know  
`ASKU` | Choose not to disclose  
**tz-code** — any valid timezone code from the [FHIR timezone ValueSet](http://build.fhir.org/valueset-timezones.html), e.g., `America/New_York`.
valueString 
string 
Used by free-text extensions:   
  - **clinical-note** — displayed under the patient's name on the clinical chart. - **administrative-note** — displayed under the patient's name on the administrative profile.
valueId 
string 
Used by the **business-line** extension. The value is the `externallyExposableId` of the business line in Canvas.
valueCodeableConcept 
json 
Used by the **genderIdentity** extension. When this extension is provided, it overrides the root `gender` field.
Click to view child attributes
coding 
array[json] 
Exactly one coding entry is allowed.
Click to view child attributes
system 
string 
**Value Options Supported:**
  - http://snomed.info/sct 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string 
Gender identity code.
**Value Options Supported:**
  - 446151000124109 (Identifies as male gender)
  - 446141000124107 (Identifies as female gender)
  - 407377005 (Female-to-male transsexual)
  - 407376001 (Male-to-female transsexual)
  - 446131000124102 (Identifies as non-conforming gender)
  - OTH (Other)
  - ASKU (Asked but unknown)
display 
string 
Representation defined by the system.
text 
string 
valueReference 
json 
Used by **patient-default-provider** (must reference a Practitioner) and **patient-default-location** (must reference a Location). Both set the default used for eligibility checks.
Click to view child attributes
reference 
string 
Reference string in the form `Practitioner/{id}` or `Location/{id}`.
type 
string 
Resource type the reference points to.
**Value Options Supported:**
  - Practitioner 
  - Location 
extension 
array[json] 
Used by compound extensions whose value is itself a list of extensions. The shape of each inner entry depends on the outer `url`:   
**us-core-race** / **us-core-ethnicity** — one or more inner extensions with `url`: `ombCategory`, `detailed`, or `text`. For `ombCategory` / `detailed`, provide a `valueCoding`. For `text`, provide a `valueString`.   
**us-core-tribal-affiliation** — exactly one inner extension with `url`: `tribalAffiliation` and a `valueCodeableConcept` containing one or more codings (each requires `system`, `code`, and `display`).   
**preferred-pharmacy** — one inner extension with `url`: `ncpdp-id` is **required** ; the NCPDP number goes in `valueIdentifier.value` (must be exactly **7 digits** , left-padded with zeros). Optional inner extensions: `default` (boolean — at most one preferred pharmacy per patient may be set to `true`), `name`, `phone-number`, `address`, `fax-number`, `specialty_type` (each `valueString`).
Click to view child attributes
url 
string 
Identifies the inner extension. See the parent description above for which value applies to which compound extension.
**Value Options Supported:**
  - ombCategory (race / ethnicity — coded category (with valueCoding).)
  - detailed (race / ethnicity — detailed coded value (with valueCoding).)
  - text (race / ethnicity — free-text representation (with valueString).)
  - tribalAffiliation (tribal-affiliation — wraps the codings (with valueCodeableConcept).)
  - ncpdp-id (preferred-pharmacy — required. Pharmacy NCPDP id (with valueIdentifier).)
  - default (preferred-pharmacy — marks this pharmacy as the default (with valueBoolean).)
  - name (preferred-pharmacy — pharmacy name (with valueString).)
  - phone-number (preferred-pharmacy — pharmacy phone number (with valueString).)
  - address (preferred-pharmacy — pharmacy address (with valueString).)
  - fax-number (preferred-pharmacy — pharmacy fax (with valueString).)
  - specialty_type (preferred-pharmacy — pharmacy specialty (with valueString).)
valueCoding 
json 
For race / ethnicity `ombCategory` and `detailed` inner extensions.
Click to view child attributes
system 
string 
For known race / ethnicity codes use the OID; for `ASKU` use the v3-NullFlavor system.
**Value Options Supported:**
  - urn:oid:2.16.840.1.113883.6.238 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string 
Race or ethnicity code from the [CDC Race and Ethnicity CodeSystem](https://hl7.org/fhir/us/core/STU3.1.1/CodeSystem-cdcrec.html). Example race codes — `2131-1` (Other Race), `2106-3` (White). Example ethnicity codes — `2186-5` (Not Hispanic or Latino), `2135-2` (Hispanic or Latino).
display 
string 
valueCodeableConcept 
json 
For the **tribal-affiliation** inner extension. Contains a `coding` list with at least one entry; each coding requires `system`, `code`, and `display`.
Click to view child attributes
coding 
array[json] 
Click to view child attributes
system 
string 
Typically `http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS`.
code 
string 
display 
string 
valueIdentifier 
json 
For the **preferred-pharmacy** `ncpdp-id` inner extension.
Click to view child attributes
value 
string 
NCPDP identifier — must be **exactly 7 digits** , left-padded with zeros if needed.
system 
string 
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber 
valueBoolean 
boolean 
For the **preferred-pharmacy** `default` inner extension. At most one preferred-pharmacy entry per patient may be set to true.
valueString 
string 
Used in two contexts:   
• For the **race** / **ethnicity** `text` inner extension — a free-text representation of the race or ethnicity.   
• For the **preferred-pharmacy** metadata inner extensions (`name`, `phone-number`, `address`, `fax-number`, `specialty_type`) — free-text values about the pharmacy.
identifier 
array[json] 
External identifiers for this patient. None of these identifiers are surfaced on the patient chart, but they may help you correlate the Canvas patient with records in your own systems.
The array always includes the Canvas-issued MRN (an entry with `system`: **http://canvasmedical.com** and a coded `type` of MR). Additional entries are external identifiers added through prior create/update calls or via the Patient profile in the Canvas UI.
Click to view child attributes
id 
string 
Canvas-issued identifier for this entry. Include on update to target an existing identifier; omit to create a new one.
use 
enum [ usual | official | temp | secondary | old ] 
Purpose of this identifier. Defaults to **usual** if omitted.
system 
string 
Free-text namespace for the value (e.g., "HealthCo", or a URL).
value 
string 
The identifier value. Must be 1–255 characters.
period 
json 
Validity window for this identifier. End-before-start is not validated.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD). Defaults to **1970-01-01** if omitted.
end 
date 
Inclusive end date (YYYY-MM-DD). Defaults to **2100-12-31** if omitted.
type 
json 
Codeable concept identifying the kind of identifier.
assigner 
json 
Organization that issued id.
active 
boolean 
Whether the patient is active in the healthcare system. Defaults to `true` if omitted on create.
name 
array[json] 
One or more names for the patient. At least one entry is required, and exactly one entry must have `use`: **official** — that entry determines the patient's first/middle/last/prefix/suffix shown across the Canvas UI.   
Additional entries with `use`: **nickname** , **maiden** , or **old** are accepted: the first item in the `given` list of a **nickname** entry is stored as the patient's preferred name. **maiden** and **old** entries are stored but not displayed in the Canvas UI. Entries with any other `use` value are ignored.   
In the Canvas UI, patients display as `first last suffix (nickname)`, and search supports first, middle, last, suffix, and nickname.
Click to view child attributes
use 
enum [ official | nickname | old | maiden ] 
At least one entry with `use`: **official** is required. See the parent description for how each accepted value is handled.
family 
string 
Family name (often called 'Surname'). Required on the **official** entry to populate the patient's last name.
given 
array[string] 
Given names. The first item populates the patient's first name; remaining items are joined with a space and stored as the middle name.   
For a **nickname** entry, only the first item is read and stored as the patient's preferred name. Surrounding whitespace is trimmed, and a value that is empty or whitespace-only is stored as an empty preferred name.
prefix 
array[string] 
Parts that come before the name (e.g., "Dr.", "Mr."). Stored but not displayed in the Canvas UI.
suffix 
array[string] 
Parts that come after the name (e.g., "Jr.", "III"). Surfaced in the Canvas UI.
period 
json 
Validity window for this name.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD).
end 
date 
Inclusive end date (YYYY-MM-DD).
telecom 
array[json] 
Patient contact points (phone / email / fax / etc.).   
Phone and email entries are surfaced in the Canvas UI. Other systems are accepted and stored but are not displayed.
Click to view child attributes
id 
string 
Canvas-issued identifier for this contact point. Include on update to target an existing entry; omit to create a new one.
extension 
array[json] 
Optional flags about the contact point. The `has-consent` extension records that the patient has consented to receive messages at this contact point — set the `url` to **http://schemas.canvasmedical.com/fhir/extensions/has-consent** with `valueBoolean: true`.   
**Note:** Setting `has-consent` here does not send a verification email or text as the Canvas UI does — it bypasses verification and marks the contact point as verified.
Click to view child attributes
url 
string 
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/has-consent 
valueBoolean 
boolean 
system 
enum [ phone | fax | email | pager | url | sms | other ] 
Telecommunications form. `url` is stored internally as **other** , and `sms` is stored as **phone**.
value 
string 
The contact point value (phone number, email address, etc.).
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point. Defaults to **home** if omitted.
rank 
integer 
Preferred order across contact points of the same `system`. Defaults to **1**.
gender 
enum [ male | female | other | unknown ] 
Maps to the gender identity field in the Canvas UI. See the [administrative gender ValueSet](https://hl7.org/fhir/R4/valueset-administrative-gender.html).   
**unknown** displays as "choose not to disclose" on the patient chart. **other** displays as "Additional gender category or other, please specify".   
**Note:** If the `genderIdentity` extension is also provided, it overrides this field.
birthDate 
date 
Patient's date of birth, formatted **YYYY-MM-DD**.   
Canvas also accepts partial dates: **YYYY-MM** defaults to the 1st of the month, and **YYYY** defaults to January 1st.
deceasedDateTime 
datetime 
Date/time the patient died. Mutually exclusive with `deceasedBoolean` — provide one or the other.
Returned in place of `deceasedBoolean` when an exact datetime is on file.
deceasedBoolean 
boolean 
Whether the patient is deceased. Use when an exact date/time isn't known.
Returned in place of `deceasedDateTime` when no exact datetime is on file.
address 
array[json] 
Address(es) for the patient.
Click to view child attributes
id 
string 
Canvas-issued identifier for this address.
use 
enum [ home | work | temp | old ] 
Defaults to **home** if omitted.
type 
enum [ both | physical | postal ] 
Defaults to **both** if omitted.
line 
array[string] 
First item populates address line 1; remaining items are concatenated as address line 2.
city 
string 
City of the address.
state 
string 
2-letter state abbreviation.
postalCode 
string 
5-digit postal code.
country 
string 
ISO 3166 2-letter country code. Defaults to **us**.
period 
json 
Validity window for this address.
Click to view child attributes
start 
date 
Inclusive start date.
end 
date 
Inclusive end date.
photo 
array[json] 
Patient photo. Displayed as the avatar in the Canvas UI.
Click to view child attributes
url 
string 
URI where the image can be retrieved. Returned on read/search; requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files).
contact 
array[json] 
Contact parties (e.g., guardian, partner, friend, emergency contact) for the patient. Contact details display on the Patient profile page in the Canvas UI.
Click to view child attributes
id 
string 
Canvas-issued identifier for this contact. Include on update to target an existing contact; omit to create a new one.
relationship 
array[json] 
Codings describing the relationship of the contact to the patient. Codings can come from the standard `v3-RoleCode` system or from your instance's [configurable contact categories](https://help.canvasmedical.com/articles/8258338559-contact-categories), including the built-in **Emergency contact** category (`code`: `EMC`). Multiple codings can be combined on a single relationship to capture, e.g., both a familial relationship (`SPS` = spouse) and a contact-category role (`EMC` = emergency contact).
Click to view child attributes
coding 
array[json] 
Code(s) defined by a terminology system.
Click to view child attributes
system 
string 
The system URL of the coding. Use **http://terminology.hl7.org/CodeSystem/v3-RoleCode** for relationship-type codings from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), or **http://schemas.canvasmedical.com/fhir/contact-category** for Canvas's configurable contact categories.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-RoleCode 
  - http://schemas.canvasmedical.com/fhir/contact-category 
code 
string 
The code of the relationship or contact category.   
For the `v3-RoleCode` system, values come from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html).   
For the `contact-category` system, values are the codes configured under [Contact Categories](https://help.canvasmedical.com/articles/8258338559-contact-categories) on your instance — for example, `EMC` (Emergency contact), `ARI` (Authorized for release of information), `POA` (Power of attorney).
display 
string 
Human-readable name of the coding.
name 
json 
A name for the contact.   
Canvas only stores `name.text`. The structured sub-fields (`family`, `given`, `prefix`, `suffix`) are populated on read **only when the contact is itself a Canvas patient** , and are derived from that patient's record — they are not accepted on create or update.
Click to view child attributes
text 
string 
Free-text representation of the contact's full name. The only name field stored for a non-patient contact.
family 
string 
Family name. Populated on read only when the contact is a Canvas patient; derived from that patient's record.
given 
array[string] 
Given names. Populated on read only when the contact is a Canvas patient.
prefix 
array[string] 
Parts that come before the name. Populated on read only when the contact is a Canvas patient.
suffix 
array[string] 
Parts that come after the name. Populated on read only when the contact is a Canvas patient.
telecom 
array[json] 
Contact points for this contact.   
Canvas stores at most one phone and one email per contact: the **first** entry with `system`: **phone** is stored as the contact's phone number, and the **first** entry with `system`: **email** is stored as the email. Entries with any other `system` value are ignored.
Click to view child attributes
system 
enum [ phone | fax | email | pager | url | sms | other ] 
Only `phone` and `email` are stored on the contact; other values are ignored.
value 
string 
The contact point value.   
For `system: phone`, the value must be **exactly 10 digits** with no other characters (no dashes, spaces, or country code). Phone values that don't match are rejected.
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point.
address 
json 
Address where the contact can be reached. Populated on read only when the contact is itself a Canvas patient (the contact's primary address is surfaced); ignored on create and update.
Click to view child attributes
use 
enum [ home | work | temp | old ] 
type 
enum [ both | physical | postal ] 
line 
array[string] 
First item is address line 1; remaining items are concatenated as address line 2.
city 
string 
district 
string 
District name (aka county).
state 
string 
2-letter state abbreviation.
postalCode 
string 
5-digit postal code.
country 
string 
ISO 3166 2-letter country code.
period 
json 
Click to view child attributes
start 
date 
end 
date 
communication 
array[json] 
Languages used to communicate with the patient.
Click to view child attributes
language 
json 
A language usable for communicating with the patient. See [Common Languages](https://hl7.org/fhir/R4/valueset-languages.html) (preferred) or [AllLanguages](https://hl7.org/fhir/R4/valueset-all-languages.html).
Click to view child attributes
coding 
array[json] 
Exactly one coding entry is allowed.
Click to view child attributes
system 
string 
**Value Options Supported:**
  - urn:ietf:bcp:47 
  - http://hl7.org/fhir/ValueSet/all-languages 
code 
string 
BCP-47 language code (e.g., `en`).
display 
string 
Human-readable language name (e.g., `English`).
text 
string 
Plain-text representation of the language.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Patient/{id}
#### Patient update
**How updates and deletions to`identifier`, `telecom`, `address`, and `contact` are handled:**  
Each entry returned via Search/Read includes an `id`.   
• If the `id` is included in an entry, Canvas updates the matching record.   
• If the `id` is omitted, Canvas creates a new record.   
• If an entry returned via Search/Read is **not** included in the update body, it is deleted (with the exception of `identifier`, which is only deleted when its `period.end` is in the future).   
The same delete-on-omission behavior applies to the `preferred-pharmacy`, `default-provider`, and `default-location` extensions — their values are dropped if those extensions are not present on update.   
**Other fields**  
Any field that is required on create is also required on update. Optional fields that are not included in the update body retain their stored values.
### Attributes
resourceType 
string required
The FHIR Resource name.
id 
string 
Canvas-issued unique identifier (UUID) for this Patient. It is the same id that appears in the URL of the patient's chart.
Must match the ID in the path parameter.
extension 
array[json] required
Canvas-supported FHIR extensions on this resource. Each entry has a `url` identifying the extension, plus either a `valueX` field or — for compound extensions (**race** , **ethnicity** , **tribal-affiliation** , **preferred-pharmacy**) — a nested `extension` array carrying the value. The `url` is matched as an exact string.   
The **birthsex** extension (`http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex`) is **required** on create and update.
**Replace semantics on update:** the **preferred-pharmacy** , **patient-default-provider** , and **patient-default-location** extensions follow delete-on-omission — if not included in the request, the stored value is dropped.
Click to view child attributes
url 
string required
Identifies the extension. See the value-field descriptions below for which `url` pairs with which `valueX` (or nested `extension`) shape.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex (Required. Patient's sex assigned at birth, per ONC; aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex (Documented sex, distinct from sex at birth.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity (Gender the patient identifies as. Overrides the root gender field when provided.)
  - http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation (Patient's sexual orientation.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race (Patient's races. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity (Patient's ethnicities. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation (Tribe or band the patient associates with. Compound — uses nested extension.)
  - http://hl7.org/fhir/StructureDefinition/tz-code (Patient's timezone.)
  - http://schemas.canvasmedical.com/fhir/extensions/clinical-note (Free-text note shown under the patient's name on the clinical chart.)
  - http://schemas.canvasmedical.com/fhir/extensions/administrative-note (Free-text note shown under the patient's name on the administrative profile.)
  - http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy (Patient's preferred pharmacy. Compound — multiple allowed; one may be marked default.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider (Default Practitioner used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-location (Default Location used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/business-line (Business line the patient belongs to. Requires Business Line functionality on the instance.)
valueCode 
string 
Used by extensions whose value is a single code.   
**birthsex** — required when this extension is included.   
Code | Meaning  
---|---  
`M` | Male  
`F` | Female  
`OTH` | Other  
`UNK` | Unknown  
**sex**   
Code | Meaning  
---|---  
`184115007` | Patient sex unknown  
`248152002` | Female  
`248153007` | Male  
`33791000087105` | Identifies as nonbinary gender  
`asked-declined` | Asked but declined  
**sexual-orientation**   
Code | Meaning  
---|---  
`20430005` | Straight or heterosexual  
`38628009` | Lesbian, gay or homosexual  
`42035005` | Bisexual  
`OTH` | Something else, please describe  
`UNK` | Don't know  
`ASKU` | Choose not to disclose  
**tz-code** — any valid timezone code from the [FHIR timezone ValueSet](http://build.fhir.org/valueset-timezones.html), e.g., `America/New_York`.
valueString 
string 
Used by free-text extensions:   
  - **clinical-note** — displayed under the patient's name on the clinical chart. - **administrative-note** — displayed under the patient's name on the administrative profile.
valueId 
string 
Used by the **business-line** extension. The value is the `externallyExposableId` of the business line in Canvas.
valueCodeableConcept 
json 
Used by the **genderIdentity** extension. When this extension is provided, it overrides the root `gender` field.
Click to view child attributes
coding 
array[json] required
Exactly one coding entry is allowed.
Click to view child attributes
system 
string required
**Value Options Supported:**
  - http://snomed.info/sct 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string required
Gender identity code.
**Value Options Supported:**
  - 446151000124109 (Identifies as male gender)
  - 446141000124107 (Identifies as female gender)
  - 407377005 (Female-to-male transsexual)
  - 407376001 (Male-to-female transsexual)
  - 446131000124102 (Identifies as non-conforming gender)
  - OTH (Other)
  - ASKU (Asked but unknown)
display 
string 
Representation defined by the system.
text 
string 
valueReference 
json 
Used by **patient-default-provider** (must reference a Practitioner) and **patient-default-location** (must reference a Location). Both set the default used for eligibility checks.
Click to view child attributes
reference 
string required
Reference string in the form `Practitioner/{id}` or `Location/{id}`.
type 
string 
Resource type the reference points to.
**Value Options Supported:**
  - Practitioner 
  - Location 
extension 
array[json] 
Used by compound extensions whose value is itself a list of extensions. The shape of each inner entry depends on the outer `url`:   
**us-core-race** / **us-core-ethnicity** — one or more inner extensions with `url`: `ombCategory`, `detailed`, or `text`. For `ombCategory` / `detailed`, provide a `valueCoding`. For `text`, provide a `valueString`.   
**us-core-tribal-affiliation** — exactly one inner extension with `url`: `tribalAffiliation` and a `valueCodeableConcept` containing one or more codings (each requires `system`, `code`, and `display`).   
**preferred-pharmacy** — one inner extension with `url`: `ncpdp-id` is **required** ; the NCPDP number goes in `valueIdentifier.value` (must be exactly **7 digits** , left-padded with zeros). Optional inner extensions: `default` (boolean — at most one preferred pharmacy per patient may be set to `true`), `name`, `phone-number`, `address`, `fax-number`, `specialty_type` (each `valueString`).
Click to view child attributes
url 
string required
Identifies the inner extension. See the parent description above for which value applies to which compound extension.
**Value Options Supported:**
  - ombCategory (race / ethnicity — coded category (with valueCoding).)
  - detailed (race / ethnicity — detailed coded value (with valueCoding).)
  - text (race / ethnicity — free-text representation (with valueString).)
  - tribalAffiliation (tribal-affiliation — wraps the codings (with valueCodeableConcept).)
  - ncpdp-id (preferred-pharmacy — required. Pharmacy NCPDP id (with valueIdentifier).)
  - default (preferred-pharmacy — marks this pharmacy as the default (with valueBoolean).)
  - name (preferred-pharmacy — pharmacy name (with valueString).)
  - phone-number (preferred-pharmacy — pharmacy phone number (with valueString).)
  - address (preferred-pharmacy — pharmacy address (with valueString).)
  - fax-number (preferred-pharmacy — pharmacy fax (with valueString).)
  - specialty_type (preferred-pharmacy — pharmacy specialty (with valueString).)
valueCoding 
json 
For race / ethnicity `ombCategory` and `detailed` inner extensions.
Click to view child attributes
system 
string required
For known race / ethnicity codes use the OID; for `ASKU` use the v3-NullFlavor system.
**Value Options Supported:**
  - urn:oid:2.16.840.1.113883.6.238 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string required
Race or ethnicity code from the [CDC Race and Ethnicity CodeSystem](https://hl7.org/fhir/us/core/STU3.1.1/CodeSystem-cdcrec.html). Example race codes — `2131-1` (Other Race), `2106-3` (White). Example ethnicity codes — `2186-5` (Not Hispanic or Latino), `2135-2` (Hispanic or Latino).
display 
string 
valueCodeableConcept 
json 
For the **tribal-affiliation** inner extension. Contains a `coding` list with at least one entry; each coding requires `system`, `code`, and `display`.
Click to view child attributes
coding 
array[json] required
Click to view child attributes
system 
string required
Typically `http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS`.
code 
string required
display 
string required
valueIdentifier 
json 
For the **preferred-pharmacy** `ncpdp-id` inner extension.
Click to view child attributes
value 
string required
NCPDP identifier — must be **exactly 7 digits** , left-padded with zeros if needed.
system 
string required
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber 
valueBoolean 
boolean 
For the **preferred-pharmacy** `default` inner extension. At most one preferred-pharmacy entry per patient may be set to true.
valueString 
string 
Used in two contexts:   
• For the **race** / **ethnicity** `text` inner extension — a free-text representation of the race or ethnicity.   
• For the **preferred-pharmacy** metadata inner extensions (`name`, `phone-number`, `address`, `fax-number`, `specialty_type`) — free-text values about the pharmacy.
identifier 
array[json] 
External identifiers for this patient. None of these identifiers are surfaced on the patient chart, but they may help you correlate the Canvas patient with records in your own systems.
The MRN is managed by Canvas — do not modify it.   
**Replace semantics:** Each entry returned via Search/Read includes an `id`. Include the `id` to preserve or modify an existing identifier; omit `id` to add a new one. An identifier already in Canvas that is **not** included in the update message will be deleted only if its `period.end` is in the future.
Click to view child attributes
id 
string 
Canvas-issued identifier for this entry. Include on update to target an existing identifier; omit to create a new one.
use 
enum [ usual | official | temp | secondary | old ] 
Purpose of this identifier. Defaults to **usual** if omitted.
system 
string required
Free-text namespace for the value (e.g., "HealthCo", or a URL).
value 
string required
The identifier value. Must be 1–255 characters.
period 
json 
Validity window for this identifier. End-before-start is not validated.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD). Defaults to **1970-01-01** if omitted.
end 
date 
Inclusive end date (YYYY-MM-DD). Defaults to **2100-12-31** if omitted.
active 
boolean 
Whether the patient is active in the healthcare system. Defaults to `true` if omitted on create.
name 
array[json] required
One or more names for the patient. At least one entry is required, and exactly one entry must have `use`: **official** — that entry determines the patient's first/middle/last/prefix/suffix shown across the Canvas UI.   
Additional entries with `use`: **nickname** , **maiden** , or **old** are accepted: the first item in the `given` list of a **nickname** entry is stored as the patient's preferred name. **maiden** and **old** entries are stored but not displayed in the Canvas UI. Entries with any other `use` value are ignored.   
In the Canvas UI, patients display as `first last suffix (nickname)`, and search supports first, middle, last, suffix, and nickname.
**Replace semantics:** Names are not addressed by `id` — the `name` array sent in the update replaces the names stored in Canvas (subject to the use-based rules above). To preserve a previously stored name, include it in the update body.
Click to view child attributes
use 
enum [ official | nickname | old | maiden ] required
At least one entry with `use`: **official** is required. See the parent description for how each accepted value is handled.
family 
string required
Family name (often called 'Surname'). Required on the **official** entry to populate the patient's last name.
given 
array[string] required
Given names. The first item populates the patient's first name; remaining items are joined with a space and stored as the middle name.   
For a **nickname** entry, only the first item is read and stored as the patient's preferred name. Surrounding whitespace is trimmed, and a value that is empty or whitespace-only is stored as an empty preferred name.
prefix 
array[string] 
Parts that come before the name (e.g., "Dr.", "Mr."). Stored but not displayed in the Canvas UI.
suffix 
array[string] 
Parts that come after the name (e.g., "Jr.", "III"). Surfaced in the Canvas UI.
period 
json 
Validity window for this name.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD).
end 
date 
Inclusive end date (YYYY-MM-DD).
telecom 
array[json] 
Patient contact points (phone / email / fax / etc.).   
Phone and email entries are surfaced in the Canvas UI. Other systems are accepted and stored but are not displayed.
**Replace semantics:** Each entry returned via Search/Read includes an `id`. Include the `id` to preserve or modify an existing contact point; omit `id` to add a new one. A contact point not included in the update message will be deleted.
Click to view child attributes
id 
string 
Canvas-issued identifier for this contact point. Include on update to target an existing entry; omit to create a new one.
extension 
array[json] 
Optional flags about the contact point. The `has-consent` extension records that the patient has consented to receive messages at this contact point — set the `url` to **http://schemas.canvasmedical.com/fhir/extensions/has-consent** with `valueBoolean: true`.   
**Note:** Setting `has-consent` here does not send a verification email or text as the Canvas UI does — it bypasses verification and marks the contact point as verified.
Click to view child attributes
url 
string required
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/has-consent 
valueBoolean 
boolean required
system 
enum [ phone | fax | email | pager | url | sms | other ] required
Telecommunications form. `url` is stored internally as **other** , and `sms` is stored as **phone**.
value 
string required
The contact point value (phone number, email address, etc.).
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point. Defaults to **home** if omitted.
rank 
integer 
Preferred order across contact points of the same `system`. Defaults to **1**.
gender 
enum [ male | female | other | unknown ] required
Maps to the gender identity field in the Canvas UI. See the [administrative gender ValueSet](https://hl7.org/fhir/R4/valueset-administrative-gender.html).   
**unknown** displays as "choose not to disclose" on the patient chart. **other** displays as "Additional gender category or other, please specify".   
**Note:** If the `genderIdentity` extension is also provided, it overrides this field.
birthDate 
date required
Patient's date of birth, formatted **YYYY-MM-DD**.   
Canvas also accepts partial dates: **YYYY-MM** defaults to the 1st of the month, and **YYYY** defaults to January 1st.
deceasedDateTime 
datetime 
Date/time the patient died. Mutually exclusive with `deceasedBoolean` — provide one or the other.
deceasedBoolean 
boolean 
Whether the patient is deceased. Use when an exact date/time isn't known.
Setting this to `false` clears the stored datetime of death; setting to `true` does not modify a previously stored datetime of death.
address 
array[json] 
Address(es) for the patient.
**Replace semantics:** Each entry returned via Search/Read includes an `id`. Include the `id` to preserve or modify an existing address; omit `id` to add a new one. An address not included in the update message will be deleted.
Click to view child attributes
id 
string 
Canvas-issued identifier for this address.
use 
enum [ home | work | temp | old ] 
Defaults to **home** if omitted.
type 
enum [ both | physical | postal ] 
Defaults to **both** if omitted.
line 
array[string] 
First item populates address line 1; remaining items are concatenated as address line 2.
city 
string 
City of the address.
state 
string 
2-letter state abbreviation.
postalCode 
string 
5-digit postal code.
country 
string 
ISO 3166 2-letter country code. Defaults to **us**.
period 
json 
Validity window for this address.
Click to view child attributes
start 
date 
Inclusive start date.
end 
date 
Inclusive end date.
photo 
array[json] 
Patient photo. Displayed as the avatar in the Canvas UI.
Click to view child attributes
data 
string 
Base64-encoded image content. Use on create or update to upload a photo.
contact 
array[json] 
Contact parties (e.g., guardian, partner, friend, emergency contact) for the patient. Contact details display on the Patient profile page in the Canvas UI.
**Replace semantics:** Each entry returned via Search/Read includes an `id`. Include the `id` to preserve or modify an existing contact; omit `id` to add a new one. A contact not included in the update message will be deleted.
Click to view child attributes
id 
string 
Canvas-issued identifier for this contact. Include on update to target an existing contact; omit to create a new one.
relationship 
array[json] 
Codings describing the relationship of the contact to the patient. Codings can come from the standard `v3-RoleCode` system or from your instance's [configurable contact categories](https://help.canvasmedical.com/articles/8258338559-contact-categories), including the built-in **Emergency contact** category (`code`: `EMC`). Multiple codings can be combined on a single relationship to capture, e.g., both a familial relationship (`SPS` = spouse) and a contact-category role (`EMC` = emergency contact).
Click to view child attributes
coding 
array[json] 
Code(s) defined by a terminology system.
Click to view child attributes
system 
string required
The system URL of the coding. Use **http://terminology.hl7.org/CodeSystem/v3-RoleCode** for relationship-type codings from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), or **http://schemas.canvasmedical.com/fhir/contact-category** for Canvas's configurable contact categories.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-RoleCode 
  - http://schemas.canvasmedical.com/fhir/contact-category 
code 
string required
The code of the relationship or contact category.   
For the `v3-RoleCode` system, values come from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html).   
For the `contact-category` system, values are the codes configured under [Contact Categories](https://help.canvasmedical.com/articles/8258338559-contact-categories) on your instance — for example, `EMC` (Emergency contact), `ARI` (Authorized for release of information), `POA` (Power of attorney).
display 
string 
Human-readable name of the coding.
name 
json required
A name for the contact.   
Canvas only stores `name.text`. The structured sub-fields (`family`, `given`, `prefix`, `suffix`) are populated on read **only when the contact is itself a Canvas patient** , and are derived from that patient's record — they are not accepted on create or update.
Click to view child attributes
text 
string required
Free-text representation of the contact's full name. The only name field stored for a non-patient contact.
telecom 
array[json] 
Contact points for this contact.   
Canvas stores at most one phone and one email per contact: the **first** entry with `system`: **phone** is stored as the contact's phone number, and the **first** entry with `system`: **email** is stored as the email. Entries with any other `system` value are ignored.
Click to view child attributes
system 
enum [ phone | fax | email | pager | url | sms | other ] required
Only `phone` and `email` are stored on the contact; other values are ignored.
value 
string required
The contact point value.   
For `system: phone`, the value must be **exactly 10 digits** with no other characters (no dashes, spaces, or country code). Phone values that don't match are rejected.
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point.
communication 
array[json] 
Languages used to communicate with the patient.
Click to view child attributes
language 
json 
A language usable for communicating with the patient. See [Common Languages](https://hl7.org/fhir/R4/valueset-languages.html) (preferred) or [AllLanguages](https://hl7.org/fhir/R4/valueset-all-languages.html).
Click to view child attributes
coding 
array[json] 
Exactly one coding entry is allowed.
Click to view child attributes
system 
string required
**Value Options Supported:**
  - urn:ietf:bcp:47 
  - http://hl7.org/fhir/ValueSet/all-languages 
code 
string required
BCP-47 language code (e.g., `en`).
display 
string required
Human-readable language name (e.g., `English`).
text 
string 
Plain-text representation of the language.
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Patient
#### Patient search
Search for patient resources.
### Query Parameters
****
_has:CareTeam:participant:member 
string 
Search for patients based on references from other resources using the FHIR reverse-chaining syntax. Currently supported for CareTeam, e.g. `_has:CareTeam:participant:member=Practitioner/{practitioner_id}`.
_id 
string 
A Canvas-issued unique identifier for the patient. This can be found in the URL of the patient's chart.
_revinclude 
string 
Standard FHIR `_revinclude` parameter.
_sort 
string 
Sort the results by a specific field. Supported values are **_id** , **birthdate** , **family** , and **given**. Prefix with **-** (e.g., **-birthdate**) to sort in descending order.
active 
boolean 
By default, both active and inactive patients are returned. Use this parameter to return only active (`true`) or only inactive (`false`) patients.
birthdate 
date 
The patient's birth date.
email 
string 
Patient email address.
family 
string 
Last name.
gender 
enum [ male | female | other | unknown ] 
The gender of the patient.
given 
string 
First name.
identifier 
string 
The Canvas-issued MRN or a saved identifier from an external system.   
**Examples:**  
`/Patient?identifier=abc123` — patients with an identifier of "abc123" issued by any system, including Canvas-issued MRNs.  
`/Patient?identifier=foo|abc123` — patients with an identifier of "abc123" issued by the system named "foo".  
`/Patient?identifier=http://canvasmedical.com|012345` — the patient with the Canvas-issued MRN of "012345".  
`/Patient?identifier=foo|` — all patients with an identifier issued by the system named "foo".  
`/Patient?identifier=|abc123` — patients with an identifier of "abc123" issued by the system named "" (empty string).
name 
string 
Part of a first or last name.
nickname 
string 
Preferred or alternate name.
phone 
string 
Patient phone number. Expected to be 10 digits.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
Canvas-issued unique identifier (UUID) for this Patient. It is the same id that appears in the URL of the patient's chart.
text 
json 
A human-readable narrative summarizing the resource. Generated by Canvas; not accepted on create or update.
extension 
array[json] 
Canvas-supported FHIR extensions on this resource. Each entry has a `url` identifying the extension, plus either a `valueX` field or — for compound extensions (**race** , **ethnicity** , **tribal-affiliation** , **preferred-pharmacy**) — a nested `extension` array carrying the value. The `url` is matched as an exact string.   
The **birthsex** extension (`http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex`) is **required** on create and update.
Click to view child attributes
url 
string 
Identifies the extension. See the value-field descriptions below for which `url` pairs with which `valueX` (or nested `extension`) shape.
**Value Options Supported:**
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex (Required. Patient's sex assigned at birth, per ONC; aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex (Documented sex, distinct from sex at birth.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity (Gender the patient identifies as. Overrides the root gender field when provided.)
  - http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation (Patient's sexual orientation.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race (Patient's races. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity (Patient's ethnicities. Compound — uses nested extension.)
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation (Tribe or band the patient associates with. Compound — uses nested extension.)
  - http://hl7.org/fhir/StructureDefinition/tz-code (Patient's timezone.)
  - http://schemas.canvasmedical.com/fhir/extensions/clinical-note (Free-text note shown under the patient's name on the clinical chart.)
  - http://schemas.canvasmedical.com/fhir/extensions/administrative-note (Free-text note shown under the patient's name on the administrative profile.)
  - http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy (Patient's preferred pharmacy. Compound — multiple allowed; one may be marked default.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider (Default Practitioner used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/patient-default-location (Default Location used for eligibility checks.)
  - http://schemas.canvasmedical.com/fhir/extensions/business-line (Business line the patient belongs to. Requires Business Line functionality on the instance.)
valueCode 
string 
Used by extensions whose value is a single code.   
**birthsex** — required when this extension is included.   
Code | Meaning  
---|---  
`M` | Male  
`F` | Female  
`OTH` | Other  
`UNK` | Unknown  
**sex**   
Code | Meaning  
---|---  
`184115007` | Patient sex unknown  
`248152002` | Female  
`248153007` | Male  
`33791000087105` | Identifies as nonbinary gender  
`asked-declined` | Asked but declined  
**sexual-orientation**   
Code | Meaning  
---|---  
`20430005` | Straight or heterosexual  
`38628009` | Lesbian, gay or homosexual  
`42035005` | Bisexual  
`OTH` | Something else, please describe  
`UNK` | Don't know  
`ASKU` | Choose not to disclose  
**tz-code** — any valid timezone code from the [FHIR timezone ValueSet](http://build.fhir.org/valueset-timezones.html), e.g., `America/New_York`.
valueString 
string 
Used by free-text extensions:   
  - **clinical-note** — displayed under the patient's name on the clinical chart. - **administrative-note** — displayed under the patient's name on the administrative profile.
valueId 
string 
Used by the **business-line** extension. The value is the `externallyExposableId` of the business line in Canvas.
valueCodeableConcept 
json 
Used by the **genderIdentity** extension. When this extension is provided, it overrides the root `gender` field.
Click to view child attributes
coding 
array[json] 
Exactly one coding entry is allowed.
Click to view child attributes
system 
string 
**Value Options Supported:**
  - http://snomed.info/sct 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string 
Gender identity code.
**Value Options Supported:**
  - 446151000124109 (Identifies as male gender)
  - 446141000124107 (Identifies as female gender)
  - 407377005 (Female-to-male transsexual)
  - 407376001 (Male-to-female transsexual)
  - 446131000124102 (Identifies as non-conforming gender)
  - OTH (Other)
  - ASKU (Asked but unknown)
display 
string 
Representation defined by the system.
text 
string 
valueReference 
json 
Used by **patient-default-provider** (must reference a Practitioner) and **patient-default-location** (must reference a Location). Both set the default used for eligibility checks.
Click to view child attributes
reference 
string 
Reference string in the form `Practitioner/{id}` or `Location/{id}`.
type 
string 
Resource type the reference points to.
**Value Options Supported:**
  - Practitioner 
  - Location 
extension 
array[json] 
Used by compound extensions whose value is itself a list of extensions. The shape of each inner entry depends on the outer `url`:   
**us-core-race** / **us-core-ethnicity** — one or more inner extensions with `url`: `ombCategory`, `detailed`, or `text`. For `ombCategory` / `detailed`, provide a `valueCoding`. For `text`, provide a `valueString`.   
**us-core-tribal-affiliation** — exactly one inner extension with `url`: `tribalAffiliation` and a `valueCodeableConcept` containing one or more codings (each requires `system`, `code`, and `display`).   
**preferred-pharmacy** — one inner extension with `url`: `ncpdp-id` is **required** ; the NCPDP number goes in `valueIdentifier.value` (must be exactly **7 digits** , left-padded with zeros). Optional inner extensions: `default` (boolean — at most one preferred pharmacy per patient may be set to `true`), `name`, `phone-number`, `address`, `fax-number`, `specialty_type` (each `valueString`).
Click to view child attributes
url 
string 
Identifies the inner extension. See the parent description above for which value applies to which compound extension.
**Value Options Supported:**
  - ombCategory (race / ethnicity — coded category (with valueCoding).)
  - detailed (race / ethnicity — detailed coded value (with valueCoding).)
  - text (race / ethnicity — free-text representation (with valueString).)
  - tribalAffiliation (tribal-affiliation — wraps the codings (with valueCodeableConcept).)
  - ncpdp-id (preferred-pharmacy — required. Pharmacy NCPDP id (with valueIdentifier).)
  - default (preferred-pharmacy — marks this pharmacy as the default (with valueBoolean).)
  - name (preferred-pharmacy — pharmacy name (with valueString).)
  - phone-number (preferred-pharmacy — pharmacy phone number (with valueString).)
  - address (preferred-pharmacy — pharmacy address (with valueString).)
  - fax-number (preferred-pharmacy — pharmacy fax (with valueString).)
  - specialty_type (preferred-pharmacy — pharmacy specialty (with valueString).)
valueCoding 
json 
For race / ethnicity `ombCategory` and `detailed` inner extensions.
Click to view child attributes
system 
string 
For known race / ethnicity codes use the OID; for `ASKU` use the v3-NullFlavor system.
**Value Options Supported:**
  - urn:oid:2.16.840.1.113883.6.238 
  - http://terminology.hl7.org/CodeSystem/v3-NullFlavor 
code 
string 
Race or ethnicity code from the [CDC Race and Ethnicity CodeSystem](https://hl7.org/fhir/us/core/STU3.1.1/CodeSystem-cdcrec.html). Example race codes — `2131-1` (Other Race), `2106-3` (White). Example ethnicity codes — `2186-5` (Not Hispanic or Latino), `2135-2` (Hispanic or Latino).
display 
string 
valueCodeableConcept 
json 
For the **tribal-affiliation** inner extension. Contains a `coding` list with at least one entry; each coding requires `system`, `code`, and `display`.
Click to view child attributes
coding 
array[json] 
Click to view child attributes
system 
string 
Typically `http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS`.
code 
string 
display 
string 
valueIdentifier 
json 
For the **preferred-pharmacy** `ncpdp-id` inner extension.
Click to view child attributes
value 
string 
NCPDP identifier — must be **exactly 7 digits** , left-padded with zeros if needed.
system 
string 
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber 
valueBoolean 
boolean 
For the **preferred-pharmacy** `default` inner extension. At most one preferred-pharmacy entry per patient may be set to true.
valueString 
string 
Used in two contexts:   
• For the **race** / **ethnicity** `text` inner extension — a free-text representation of the race or ethnicity.   
• For the **preferred-pharmacy** metadata inner extensions (`name`, `phone-number`, `address`, `fax-number`, `specialty_type`) — free-text values about the pharmacy.
identifier 
array[json] 
External identifiers for this patient. None of these identifiers are surfaced on the patient chart, but they may help you correlate the Canvas patient with records in your own systems.
The array always includes the Canvas-issued MRN (an entry with `system`: **http://canvasmedical.com** and a coded `type` of MR). Additional entries are external identifiers added through prior create/update calls or via the Patient profile in the Canvas UI.
Click to view child attributes
id 
string 
Canvas-issued identifier for this entry. Include on update to target an existing identifier; omit to create a new one.
use 
enum [ usual | official | temp | secondary | old ] 
Purpose of this identifier. Defaults to **usual** if omitted.
system 
string 
Free-text namespace for the value (e.g., "HealthCo", or a URL).
value 
string 
The identifier value. Must be 1–255 characters.
period 
json 
Validity window for this identifier. End-before-start is not validated.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD). Defaults to **1970-01-01** if omitted.
end 
date 
Inclusive end date (YYYY-MM-DD). Defaults to **2100-12-31** if omitted.
type 
json 
Codeable concept identifying the kind of identifier.
assigner 
json 
Organization that issued id.
active 
boolean 
Whether the patient is active in the healthcare system. Defaults to `true` if omitted on create.
name 
array[json] 
One or more names for the patient. At least one entry is required, and exactly one entry must have `use`: **official** — that entry determines the patient's first/middle/last/prefix/suffix shown across the Canvas UI.   
Additional entries with `use`: **nickname** , **maiden** , or **old** are accepted: the first item in the `given` list of a **nickname** entry is stored as the patient's preferred name. **maiden** and **old** entries are stored but not displayed in the Canvas UI. Entries with any other `use` value are ignored.   
In the Canvas UI, patients display as `first last suffix (nickname)`, and search supports first, middle, last, suffix, and nickname.
Click to view child attributes
use 
enum [ official | nickname | old | maiden ] 
At least one entry with `use`: **official** is required. See the parent description for how each accepted value is handled.
family 
string 
Family name (often called 'Surname'). Required on the **official** entry to populate the patient's last name.
given 
array[string] 
Given names. The first item populates the patient's first name; remaining items are joined with a space and stored as the middle name.   
For a **nickname** entry, only the first item is read and stored as the patient's preferred name. Surrounding whitespace is trimmed, and a value that is empty or whitespace-only is stored as an empty preferred name.
prefix 
array[string] 
Parts that come before the name (e.g., "Dr.", "Mr."). Stored but not displayed in the Canvas UI.
suffix 
array[string] 
Parts that come after the name (e.g., "Jr.", "III"). Surfaced in the Canvas UI.
period 
json 
Validity window for this name.
Click to view child attributes
start 
date 
Inclusive start date (YYYY-MM-DD).
end 
date 
Inclusive end date (YYYY-MM-DD).
telecom 
array[json] 
Patient contact points (phone / email / fax / etc.).   
Phone and email entries are surfaced in the Canvas UI. Other systems are accepted and stored but are not displayed.
Click to view child attributes
id 
string 
Canvas-issued identifier for this contact point. Include on update to target an existing entry; omit to create a new one.
extension 
array[json] 
Optional flags about the contact point. The `has-consent` extension records that the patient has consented to receive messages at this contact point — set the `url` to **http://schemas.canvasmedical.com/fhir/extensions/has-consent** with `valueBoolean: true`.   
**Note:** Setting `has-consent` here does not send a verification email or text as the Canvas UI does — it bypasses verification and marks the contact point as verified.
Click to view child attributes
url 
string 
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/has-consent 
valueBoolean 
boolean 
system 
enum [ phone | fax | email | pager | url | sms | other ] 
Telecommunications form. `url` is stored internally as **other** , and `sms` is stored as **phone**.
value 
string 
The contact point value (phone number, email address, etc.).
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point. Defaults to **home** if omitted.
rank 
integer 
Preferred order across contact points of the same `system`. Defaults to **1**.
gender 
enum [ male | female | other | unknown ] 
Maps to the gender identity field in the Canvas UI. See the [administrative gender ValueSet](https://hl7.org/fhir/R4/valueset-administrative-gender.html).   
**unknown** displays as "choose not to disclose" on the patient chart. **other** displays as "Additional gender category or other, please specify".   
**Note:** If the `genderIdentity` extension is also provided, it overrides this field.
birthDate 
date 
Patient's date of birth, formatted **YYYY-MM-DD**.   
Canvas also accepts partial dates: **YYYY-MM** defaults to the 1st of the month, and **YYYY** defaults to January 1st.
deceasedDateTime 
datetime 
Date/time the patient died. Mutually exclusive with `deceasedBoolean` — provide one or the other.
Returned in place of `deceasedBoolean` when an exact datetime is on file.
deceasedBoolean 
boolean 
Whether the patient is deceased. Use when an exact date/time isn't known.
Returned in place of `deceasedDateTime` when no exact datetime is on file.
address 
array[json] 
Address(es) for the patient.
Click to view child attributes
id 
string 
Canvas-issued identifier for this address.
use 
enum [ home | work | temp | old ] 
Defaults to **home** if omitted.
type 
enum [ both | physical | postal ] 
Defaults to **both** if omitted.
line 
array[string] 
First item populates address line 1; remaining items are concatenated as address line 2.
city 
string 
City of the address.
state 
string 
2-letter state abbreviation.
postalCode 
string 
5-digit postal code.
country 
string 
ISO 3166 2-letter country code. Defaults to **us**.
period 
json 
Validity window for this address.
Click to view child attributes
start 
date 
Inclusive start date.
end 
date 
Inclusive end date.
photo 
array[json] 
Patient photo. Displayed as the avatar in the Canvas UI.
Click to view child attributes
url 
string 
URI where the image can be retrieved. Returned on read/search; requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files).
contact 
array[json] 
Contact parties (e.g., guardian, partner, friend, emergency contact) for the patient. Contact details display on the Patient profile page in the Canvas UI.
Click to view child attributes
id 
string 
Canvas-issued identifier for this contact. Include on update to target an existing contact; omit to create a new one.
relationship 
array[json] 
Codings describing the relationship of the contact to the patient. Codings can come from the standard `v3-RoleCode` system or from your instance's [configurable contact categories](https://help.canvasmedical.com/articles/8258338559-contact-categories), including the built-in **Emergency contact** category (`code`: `EMC`). Multiple codings can be combined on a single relationship to capture, e.g., both a familial relationship (`SPS` = spouse) and a contact-category role (`EMC` = emergency contact).
Click to view child attributes
coding 
array[json] 
Code(s) defined by a terminology system.
Click to view child attributes
system 
string 
The system URL of the coding. Use **http://terminology.hl7.org/CodeSystem/v3-RoleCode** for relationship-type codings from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), or **http://schemas.canvasmedical.com/fhir/contact-category** for Canvas's configurable contact categories.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-RoleCode 
  - http://schemas.canvasmedical.com/fhir/contact-category 
code 
string 
The code of the relationship or contact category.   
For the `v3-RoleCode` system, values come from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html).   
For the `contact-category` system, values are the codes configured under [Contact Categories](https://help.canvasmedical.com/articles/8258338559-contact-categories) on your instance — for example, `EMC` (Emergency contact), `ARI` (Authorized for release of information), `POA` (Power of attorney).
display 
string 
Human-readable name of the coding.
name 
json 
A name for the contact.   
Canvas only stores `name.text`. The structured sub-fields (`family`, `given`, `prefix`, `suffix`) are populated on read **only when the contact is itself a Canvas patient** , and are derived from that patient's record — they are not accepted on create or update.
Click to view child attributes
text 
string 
Free-text representation of the contact's full name. The only name field stored for a non-patient contact.
family 
string 
Family name. Populated on read only when the contact is a Canvas patient; derived from that patient's record.
given 
array[string] 
Given names. Populated on read only when the contact is a Canvas patient.
prefix 
array[string] 
Parts that come before the name. Populated on read only when the contact is a Canvas patient.
suffix 
array[string] 
Parts that come after the name. Populated on read only when the contact is a Canvas patient.
telecom 
array[json] 
Contact points for this contact.   
Canvas stores at most one phone and one email per contact: the **first** entry with `system`: **phone** is stored as the contact's phone number, and the **first** entry with `system`: **email** is stored as the email. Entries with any other `system` value are ignored.
Click to view child attributes
system 
enum [ phone | fax | email | pager | url | sms | other ] 
Only `phone` and `email` are stored on the contact; other values are ignored.
value 
string 
The contact point value.   
For `system: phone`, the value must be **exactly 10 digits** with no other characters (no dashes, spaces, or country code). Phone values that don't match are rejected.
use 
enum [ home | work | temp | old | mobile ] 
Purpose of this contact point.
address 
json 
Address where the contact can be reached. Populated on read only when the contact is itself a Canvas patient (the contact's primary address is surfaced); ignored on create and update.
Click to view child attributes
use 
enum [ home | work | temp | old ] 
type 
enum [ both | physical | postal ] 
line 
array[string] 
First item is address line 1; remaining items are concatenated as address line 2.
city 
string 
district 
string 
District name (aka county).
state 
string 
2-letter state abbreviation.
postalCode 
string 
5-digit postal code.
country 
string 
ISO 3166 2-letter country code.
period 
json 
Click to view child attributes
start 
date 
end 
date 
communication 
array[json] 
Languages used to communicate with the patient.
Click to view child attributes
language 
json 
A language usable for communicating with the patient. See [Common Languages](https://hl7.org/fhir/R4/valueset-languages.html) (preferred) or [AllLanguages](https://hl7.org/fhir/R4/valueset-all-languages.html).
Click to view child attributes
coding 
array[json] 
Exactly one coding entry is allowed.
Click to view child attributes
system 
string 
**Value Options Supported:**
  - urn:ietf:bcp:47 
  - http://hl7.org/fhir/ValueSet/all-languages 
code 
string 
BCP-47 language code (e.g., `en`).
display 
string 
Human-readable language name (e.g., `English`).
text 
string 
Plain-text representation of the language.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```sh
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Patient' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Patient",
            "extension":
            [
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                    "valueCode": "F"
                },
                {
                    "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
                    "valueCode" : "248152002"
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
                    "valueCodeableConcept":
                    {
                        "coding":
                        [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "446141000124107",
                                "display": "Identifies as female gender (finding)"
                            }
                        ],
                        "text": "Identifies as female gender (finding)"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation",
                    "valueCode": "20430005"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy",
                    "extension":
                    [
                        {
                            "url": "ncpdp-id",
                            "valueIdentifier":
                            {
                                "value": "1123152",
                                "system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber"
                            }
                        }
                    ]
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider",
                    "valueReference": {
                        "reference": "Practitioner/55096fbcdfb240fd8c999c325304de03",
                        "type": "Practitioner"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2131-1",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2186-5",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
                    "extension":
                    [
                        {
                            "url": "tribalAffiliation",
                            "valueCodeableConcept":
                            {
                                "coding":
                                [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                                        "code": "187",
                                        "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/tz-code",
                    "valueCode": "America/New_York"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/clinical-note",
                    "valueString": "I am a clinical caption from a Create message"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/administrative-note",
                    "valueString": "I am an administrative caption from a Create message"
                }
            ],
            "identifier":
            [
                {
                    "use": "usual",
                    "system": "HealthCo",
                    "value": "s07960990"
                }
            ],
            "active": true,
            "name":
            [
                {
                    "use": "official",
                    "family": "Jones",
                    "given":
                    [
                        "Samantha",
                        "Ann"
                    ],
                    "prefix": [
                        "Dr."
                    ],
                    "suffix": [
                        "Jr."
                    ]
                },
                {
                    "use": "nickname",
                    "given":
                    [
                        "Sammy"
                    ]
                }
            ],
            "telecom":
            [
                {
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                }
            ],
            "gender": "female",
            "birthDate": "1980-11-13",
            "address":
            [
                {
                    "use": "home",
                    "type": "both",
                    "text": "1234 Main St., Los Angeles, CA 94107",
                    "line":
                    [
                        "1234 Main St."
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107"
                }
            ],
            "photo":
            [
                {
                    "data": "R0lGODlhEwARAPcAAAAAAAAA/+9aAO+1AP/WAP/eAP/eCP/eEP/eGP/nAP/nCP/nEP/nIf/nKf/nUv/nWv/vAP/vCP/vEP/vGP/vIf/vKf/vMf/vOf/vWv/vY//va//vjP/3c//3lP/3nP//tf//vf///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////yH5BAEAAAEALAAAAAATABEAAAi+AAMIDDCgYMGBCBMSvMCQ4QCFCQcwDBGCA4cLDyEGECDxAoAQHjxwyKhQAMeGIUOSJJjRpIAGDS5wCDly4AALFlYOgHlBwwOSNydM0AmzwYGjBi8IHWoTgQYORg8QIGDAwAKhESI8HIDgwQaRDI1WXXAhK9MBBzZ8/XDxQoUFZC9IiCBh6wEHGz6IbNuwQoSpWxEgyLCXL8O/gAnylNlW6AUEBRIL7Og3KwQIiCXb9HsZQoIEUzUjNEiaNMKAAAA7"
                }
            ],
            "contact":
            [
                {
                    "name":
                    {
                        "text": "Dan Jones"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "SPS",
                                    "display": "spouse"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "ARI",
                                    "display": "Authorized for release of information"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "POA",
                                    "display": "Power of attorney"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "EMC",
                                    "display": "Emergency contact"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "danjones@example.com"
                        }
                    ]
                },
                {
                    "name":
                    {
                        "text": "Linda Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "MTH",
                                    "display": "mother"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "phone",
                            "value": "5557327068"
                        }
                    ]
                },
                {
                    "name":
                    {
                        "text": "Jimmy Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "FTH",
                                    "display": "father"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "j.stewart@example.com"
                        }
                    ]
                }
            ],
            "communication":
            [
                {
                    "language":
                    {
                        "coding":
                        [
                            {
                                "system": "urn:ietf:bcp:47",
                                "code": "en",
                                "display": "English"
                            }
                        ],
                        "text": "English"
                    }
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Patient"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Patient",
            "extension":
            [
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                    "valueCode": "F"
                },
                {
                    "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
                    "valueCode" : "248152002"
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
                    "valueCodeableConcept":
                    {
                        "coding":
                        [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "446141000124107",
                                "display": "Identifies as female gender (finding)"
                            }
                        ],
                        "text": "Identifies as female gender (finding)"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation",
                    "valueCode": "20430005"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy",
                    "extension":
                    [
                        {
                            "url": "ncpdp-id",
                            "valueIdentifier":
                            {
                                "value": "1123152",
                                "system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber"
                            }
                        }
                    ]
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider",
                    "valueReference": {
                        "reference": "Practitioner/55096fbcdfb240fd8c999c325304de03",
                        "type": "Practitioner"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2131-1",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2186-5",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
                    "extension":
                    [
                        {
                            "url": "tribalAffiliation",
                            "valueCodeableConcept":
                            {
                                "coding":
                                [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                                        "code": "187",
                                        "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/tz-code",
                    "valueCode": "America/New_York"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/clinical-note",
                    "valueString": "I am a clinical caption from a Create message"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/administrative-note",
                    "valueString": "I am an administrative caption from a Create message"
                }
            ],
            "identifier":
            [
                {
                    "use": "usual",
                    "system": "HealthCo",
                    "value": "s07960990"
                }
            ],
            "active": True,
            "name":
            [
                {
                    "use": "official",
                    "family": "Jones",
                    "given":
                    [
                        "Samantha",
                        "Ann"
                    ]
                },
                {
                    "use": "nickname",
                    "given":
                    [
                        "Sammy"
                    ]
                }
            ],
            "telecom":
            [
                {
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                }
            ],
            "gender": "female",
            "birthDate": "1980-11-13",
            "address":
            [
                {
                    "use": "home",
                    "type": "both",
                    "text": "1234 Main St., Los Angeles, CA 94107",
                    "line":
                    [
                        "1234 Main St."
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107"
                }
            ],
            "photo":
            [
                {
                    "data": "R0lGODlhEwARAPcAAAAAAAAA/+9aAO+1AP/WAP/eAP/eCP/eEP/eGP/nAP/nCP/nEP/nIf/nKf/nUv/nWv/vAP/vCP/vEP/vGP/vIf/vKf/vMf/vOf/vWv/vY//va//vjP/3c//3lP/3nP//tf//vf///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////yH5BAEAAAEALAAAAAATABEAAAi+AAMIDDCgYMGBCBMSvMCQ4QCFCQcwDBGCA4cLDyEGECDxAoAQHjxwyKhQAMeGIUOSJJjRpIAGDS5wCDly4AALFlYOgHlBwwOSNydM0AmzwYGjBi8IHWoTgQYORg8QIGDAwAKhESI8HIDgwQaRDI1WXXAhK9MBBzZ8/XDxQoUFZC9IiCBh6wEHGz6IbNuwQoSpWxEgyLCXL8O/gAnylNlW6AUEBRIL7Og3KwQIiCXb9HsZQoIEUzUjNEiaNMKAAAA7"
                }
            ],
            "contact":
            [
                {
                    "name":
                    {
                        "text": "Dan Jones"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "SPS",
                                    "display": "spouse"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "ARI",
                                    "display": "Authorized for release of information"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "POA",
                                    "display": "Power of attorney"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "EMC",
                                    "display": "Emergency contact"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "danjones@example.com"
                        }
                    ]
                },
                {
                    "name":
                    {
                        "text": "Linda Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "MTH",
                                    "display": "mother"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "phone",
                            "value": "5557327068"
                        }
                    ]
                },
                {
                    "name":
                    {
                        "text": "Jimmy Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "FTH",
                                    "display": "father"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "j.stewart@example.com"
                        }
                    ]
                }
            ],
            "communication":
            [
                {
                    "language":
                    {
                        "coding":
                        [
                            {
                                "system": "urn:ietf:bcp:47",
                                "code": "en",
                                "display": "English"
                            }
                        ],
                        "text": "English"
                    }
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Patient/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Patient/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Patient",
            "id": "7162fd82487e4dc8aa2581ddbca91892",
            "text":
            {
                "status": "generated",
                "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Samantha<b>Jones</b></div><table class=\"hapiPropertyTable\"><tbody><tr><td>Identifier</td><td>963277285</td></tr><tr><td>Date of birth</td><td><span>1980-11-13</span></td></tr></tbody></table></div>"
            },
            "extension":
            [
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                    "valueCode": "F"
                },
                {
                    "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
                    "valueCode" : "248152002"
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
                    "valueCodeableConcept":
                    {
                        "coding":
                        [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "446141000124107",
                                "display": "Identifies as female gender (finding)"
                            }
                        ],
                        "text": "Identifies as female gender (finding)"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation",
                    "valueCode": "20430005"
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "system": "urn:oid:2.16.840.1.113883.6.238",
                                "code": "2131-1",
                                "display": "Other Race"
                            }
                        },
                        {
                            "url": "text",
                            "valueString": "Other Race"
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "system": "urn:oid:2.16.840.1.113883.6.238",
                                "code": "2186-5",
                                "display": "Not Hispanic or Latino"
                            }
                        },
                        {
                            "url": "text",
                            "valueString": "Not Hispanic or Latino"
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
                    "extension":
                    [
                        {
                            "url": "tribalAffiliation",
                            "valueCodeableConcept":
                            {
                                "coding":
                                [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                                        "code": "187",
                                        "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/tz-code",
                    "valueCode": "America/New_York"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/clinical-note",
                    "valueString": "I am a clinical caption from a Create message"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/administrative-note",
                    "valueString": "I am an administrative caption from a Create message"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy",
                    "extension":
                    [
                        {
                            "url": "ncpdp-id",
                            "valueIdentifier":
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber",
                                "value": "1123152"
                            }
                        },
                        {
                            "url": "specialty_type",
                            "valueString": "Retail"
                        },
                        {
                            "url": "default",
                            "valueBoolean": false
                        }
                    ]
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider",
                    "valueReference": {
                        "reference": "Practitioner/55096fbcdfb240fd8c999c325304de03",
                        "type": "Practitioner",
                        "display": "Steven Magee"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location",
                        "display": "Canvas Clinic San Francisco"
                    }
                }
            ],
            "identifier":
            [
                {
                    "use": "usual",
                    "type":
                    {
                        "coding":
                        [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                "code": "MR"
                            }
                        ]
                    },
                    "system": "http://canvasmedical.com",
                    "value": "963277285",
                    "assigner":
                    {
                        "display": "Canvas Medical"
                    }
                },
                {
                    "id": "1e628d77-5cdd-400f-a239-b24929d4a0aa",
                    "use": "usual",
                    "system": "HealthCo",
                    "value": "s07960990",
                    "period":
                    {
                        "start": "1970-01-01",
                        "end": "2100-12-31"
                    }
                }
            ],
            "active": true,
            "name":
            [
                {
                    "use": "official",
                    "family": "Jones",
                    "given":
                    [
                        "Samantha",
                        "Ann"
                    ],
                    "period":
                    {
                        "start": "0001-01-01T00:00:00+00:00",
                        "end": "9999-12-31T23:59:59.999999+00:00"
                    }
                },
                {
                    "use": "nickname",
                    "given":
                    [
                        "Sammy"
                    ],
                    "period":
                    {
                        "start": "0001-01-01T00:00:00+00:00",
                        "end": "9999-12-31T23:59:59.999999+00:00"
                    }
                }
            ],
            "telecom":
            [
                {
                    "id": "aa0d6ad0-0b69-4740-9c8c-759c769a63d1",
                    "extension":
                    [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/has-consent",
                            "valueBoolean": false
                        }
                    ],
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "id": "49c0c29d-c56e-41bb-89ab-79562bb75afc",
                    "extension":
                    [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/has-consent",
                            "valueBoolean": false
                        }
                    ],
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                }
            ],
            "gender": "female",
            "birthDate": "1980-11-13",
            "deceasedBoolean": false,
            "address":
            [
                {
                    "id": "611aaf01-a515-4d55-b43d-88b8735359f7",
                    "use": "home",
                    "type": "both",
                    "line":
                    [
                        "1234 Main St."
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107",
                    "country": "United States"
                }
            ],
            "photo":
            [
                {
                    "url": "https://fumage-example.canvasmedical.com/Patient/7162fd82487e4dc8aa2581ddbca91892/files/photo"
                }
            ],
            "contact":
            [
                {
                    "id": "1ba81cb4-7f97-429d-b0d8-4c4f067b11a5",
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "SPS",
                                    "display": "spouse"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "ARI",
                                    "display": "Authorized for release of information"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "POA",
                                    "display": "Power of attorney"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "EMC",
                                    "display": "Emergency contact"
                                }
                            ]
                        }
                    ],
                    "name":
                    {
                        "text": "Dan Jones"
                    },
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "danjones@example.com"
                        }
                    ]
                },
                {
                    "id": "f259a2b0-6bae-479b-8efe-f9436046cfb3",
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "MTH",
                                    "display": "mother"
                                }
                            ]
                        }
                    ],
                    "name":
                    {
                        "text": "Linda Stewart"
                    },
                    "telecom":
                    [
                        {
                            "system": "phone",
                            "value": "5557327068"
                        }
                    ]
                },
                {
                    "id": "30639a10-18c2-4222-8d26-32b2ca36a1bb",
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "FTH",
                                    "display": "father"
                                }
                            ]
                        }
                    ],
                    "name":
                    {
                        "text": "Jimmy Stewart"
                    },
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "j.stewart@example.com"
                        }
                    ]
                }
            ],
            "communication":
            [
                {
                    "language":
                    {
                        "coding":
                        [
                            {
                                "system": "urn:ietf:bcp:47",
                                "code": "en",
                                "display": "English"
                            }
                        ],
                        "text": "English"
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Patient resource 'a47c7b0ebbb442cdbc4adf259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```sh
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Patient/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Patient",
            "extension":
            [
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                    "valueCode": "F"
                },
                {
                    "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
                    "valueCode" : "248152002"
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
                    "valueCodeableConcept":
                    {
                        "coding":
                        [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "446141000124107",
                                "display": "Identifies as female gender (finding)"
                            }
                        ],
                        "text": "Identifies as female gender (finding)"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation",
                    "valueCode": "20430005"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy",
                    "extension":
                    [
                        {
                            "url": "ncpdp-id",
                            "valueIdentifier":
                            {
                                "value": "1123152",
                                "system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber"
                            }
                        }
                    ]
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider",
                    "valueReference": {
                        "reference": "Practitioner/55096fbcdfb240fd8c999c325304de03",
                        "type": "Practitioner"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2131-1",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2186-5",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
                    "extension":
                    [
                        {
                            "url": "tribalAffiliation",
                            "valueCodeableConcept":
                            {
                                "coding":
                                [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                                        "code": "187",
                                        "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/tz-code",
                    "valueCode": "America/New_York"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/clinical-note",
                    "valueString": "Prefers to be called Sammy"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/administrative-note",
                    "valueString": "I am an administrative caption from a Create message"
                }
            ],
            "identifier":
            [
                {
                    "use": "usual",
                    "system": "HealthCo",
                    "value": "s07960990"
                }
            ],
            "active": true,
            "name":
            [
                {
                    "use": "official",
                    "family": "Jones",
                    "given":
                    [
                        "Samantha",
                        "Ann"
                    ],
                    "prefix": [
                        "Dr."
                    ],
                    "suffix": [
                        "Jr."
                    ]
                },
                {
                    "use": "nickname",
                    "given":
                    [
                        "Sammy"
                    ]
                }
            ],
            "telecom":
            [
                {
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                }
            ],
            "gender": "female",
            "birthDate": "1980-11-13",
            "address":
            [
                {
                    "use": "home",
                    "type": "both",
                    "text": "1234 Main St., Los Angeles, CA 94107",
                    "line":
                    [
                        "1234 Main St."
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107"
                }
            ],
            "photo":
            [
                {
                    "data": "R0lGODlhEwARAPcAAAAAAAAA/+9aAO+1AP/WAP/eAP/eCP/eEP/eGP/nAP/nCP/nEP/nIf/nKf/nUv/nWv/vAP/vCP/vEP/vGP/vIf/vKf/vMf/vOf/vWv/vY//va//vjP/3c//3lP/3nP//tf//vf///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////yH5BAEAAAEALAAAAAATABEAAAi+AAMIDDCgYMGBCBMSvMCQ4QCFCQcwDBGCA4cLDyEGECDxAoAQHjxwyKhQAMeGIUOSJJjRpIAGDS5wCDly4AALFlYOgHlBwwOSNydM0AmzwYGjBi8IHWoTgQYORg8QIGDAwAKhESI8HIDgwQaRDI1WXXAhK9MBBzZ8/XDxQoUFZC9IiCBh6wEHGz6IbNuwQoSpWxEgyLCXL8O/gAnylNlW6AUEBRIL7Og3KwQIiCXb9HsZQoIEUzUjNEiaNMKAAAA7"
                }
            ],
            "contact":
            [
                {
                    "id": "1ba81cb4-7f97-429d-b0d8-4c4f067b11a5",
                    "name":
                    {
                        "text": "Dan Jones"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "SPS",
                                    "display": "spouse"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "ARI",
                                    "display": "Authorized for release of information"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "POA",
                                    "display": "Power of attorney"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "EMC",
                                    "display": "Emergency contact"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "danjones@example.com"
                        }
                    ]
                },
                {
                    "id": "f259a2b0-6bae-479b-8efe-f9436046cfb3",
                    "name":
                    {
                        "text": "Linda Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "MTH",
                                    "display": "mother"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "phone",
                            "value": "5557327068"
                        }
                    ]
                },
                {
                    "id": "30639a10-18c2-4222-8d26-32b2ca36a1bb",
                    "name":
                    {
                        "text": "Jimmy Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "FTH",
                                    "display": "father"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "j.stewart@example.com"
                        }
                    ]
                }
            ],
            "communication":
            [
                {
                    "language":
                    {
                        "coding":
                        [
                            {
                                "system": "urn:ietf:bcp:47",
                                "code": "en",
                                "display": "English"
                            }
                        ],
                        "text": "English"
                    }
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Patient/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Patient",
            "extension":
            [
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                    "valueCode": "F"
                },
                {
                    "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
                    "valueCode" : "248152002"
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
                    "valueCodeableConcept":
                    {
                        "coding":
                        [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "446141000124107",
                                "display": "Identifies as female gender (finding)"
                            }
                        ],
                        "text": "Identifies as female gender (finding)"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy",
                    "extension":
                    [
                        {
                            "url": "ncpdp-id",
                            "valueIdentifier":
                            {
                                "value": "1123152",
                                "system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber"
                            }
                        }
                    ]
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider",
                    "valueReference": {
                        "reference": "Practitioner/55096fbcdfb240fd8c999c325304de03",
                        "type": "Practitioner"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2131-1",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
                    "extension":
                    [
                        {
                            "url": "ombCategory",
                            "valueCoding":
                            {
                                "code": "2186-5",
                                "system": "urn:oid:2.16.840.1.113883.6.238"
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
                    "extension":
                    [
                        {
                            "url": "tribalAffiliation",
                            "valueCodeableConcept":
                            {
                                "coding":
                                [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                                        "code": "187",
                                        "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/tz-code",
                    "valueCode": "America/New_York"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/clinical-note",
                    "valueString": "Prefers to be called Sammy"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/administrative-note",
                    "valueString": "I am an administrative caption from a Create message"
                }
            ],
            "identifier":
            [
                {
                    "use": "usual",
                    "system": "HealthCo",
                    "value": "s07960990"
                }
            ],
            "active": True,
            "name":
            [
                {
                    "use": "official",
                    "family": "Jones",
                    "given":
                    [
                        "Samantha",
                        "Ann"
                    ],
                    "prefix": [
                        "Dr."
                    ],
                    "suffix": [
                        "Jr."
                    ]
                },
                {
                    "use": "nickname",
                    "given":
                    [
                        "Sammy"
                    ]
                }
            ],
            "telecom":
            [
                {
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                }
            ],
            "gender": "female",
            "birthDate": "1980-11-13",
            "address":
            [
                {
                    "use": "home",
                    "type": "both",
                    "text": "1234 Main St., Los Angeles, CA 94107",
                    "line":
                    [
                        "1234 Main St."
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107"
                }
            ],
            "photo":
            [
                {
                    "data": "R0lGODlhEwARAPcAAAAAAAAA/+9aAO+1AP/WAP/eAP/eCP/eEP/eGP/nAP/nCP/nEP/nIf/nKf/nUv/nWv/vAP/vCP/vEP/vGP/vIf/vKf/vMf/vOf/vWv/vY//va//vjP/3c//3lP/3nP//tf//vf///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////yH5BAEAAAEALAAAAAATABEAAAi+AAMIDDCgYMGBCBMSvMCQ4QCFCQcwDBGCA4cLDyEGECDxAoAQHjxwyKhQAMeGIUOSJJjRpIAGDS5wCDly4AALFlYOgHlBwwOSNydM0AmzwYGjBi8IHWoTgQYORg8QIGDAwAKhESI8HIDgwQaRDI1WXXAhK9MBBzZ8/XDxQoUFZC9IiCBh6wEHGz6IbNuwQoSpWxEgyLCXL8O/gAnylNlW6AUEBRIL7Og3KwQIiCXb9HsZQoIEUzUjNEiaNMKAAAA7"
                }
            ],
            "contact":
            [
                {
                    "id": "1ba81cb4-7f97-429d-b0d8-4c4f067b11a5",
                    "name":
                    {
                        "text": "Dan Jones"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "SPS",
                                    "display": "spouse"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "ARI",
                                    "display": "Authorized for release of information"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "POA",
                                    "display": "Power of attorney"
                                },
                                {
                                    "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                    "code": "EMC",
                                    "display": "Emergency contact"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "danjones@example.com"
                        }
                    ]
                },
                {
                    "id": "f259a2b0-6bae-479b-8efe-f9436046cfb3",
                    "name":
                    {
                        "text": "Linda Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "MTH",
                                    "display": "mother"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "phone",
                            "value": "5557327068"
                        }
                    ]
                },
                {
                    "id": "30639a10-18c2-4222-8d26-32b2ca36a1bb",
                    "name":
                    {
                        "text": "Jimmy Stewart"
                    },
                    "relationship":
                    [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                    "code": "FTH",
                                    "display": "father"
                                }
                            ]
                        }
                    ],
                    "telecom":
                    [
                        {
                            "system": "email",
                            "value": "j.stewart@example.com"
                        }
                    ]
                }
            ],
            "communication":
            [
                {
                    "language":
                    {
                        "coding":
                        [
                            {
                                "system": "urn:ietf:bcp:47",
                                "code": "en",
                                "display": "English"
                            }
                        ],
                        "text": "English"
                    }
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Patient resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Patient?family=Jones&gender=female' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Patient?family=Jones&gender=female"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link":
            [
                {
                    "relation": "self",
                    "url": "/Patient?family=Jones&gender=female&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Patient?family=Jones&gender=female&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Patient?family=Jones&gender=female&_count=10&_offset=0"
                }
            ],
            "entry":
            [
                {
                    "resource":
                    {
                        "resourceType": "Patient",
                        "id": "7162fd82487e4dc8aa2581ddbca91892",
                        "text":
                        {
                            "status": "generated",
                            "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Samantha<b>Jones</b></div><table class=\"hapiPropertyTable\"><tbody><tr><td>Identifier</td><td>963277285</td></tr><tr><td>Date of birth</td><td><span>1980-11-13</span></td></tr></tbody></table></div>"
                        },
                        "extension":
                        [
                            {
                                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                                "valueCode": "F"
                            },
                            {
                                "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
                                "valueCode" : "248152002"
                            },
                            {
                                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
                                "valueCodeableConcept":
                                {
                                    "coding":
                                    [
                                        {
                                            "system": "http://snomed.info/sct",
                                            "code": "446141000124107",
                                            "display": "Identifies as female gender (finding)"
                                        }
                                    ],
                                    "text": "Identifies as female gender (finding)"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/sexual-orientation",
                                "valueCode": "20430005"
                            },
                            {
                                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                                "extension":
                                [
                                    {
                                        "url": "ombCategory",
                                        "valueCoding":
                                        {
                                            "system": "urn:oid:2.16.840.1.113883.6.238",
                                            "code": "2131-1",
                                            "display": "Other Race"
                                        }
                                    },
                                    {
                                        "url": "text",
                                        "valueString": "Other Race"
                                    }
                                ]
                            },
                            {
                                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
                                "extension":
                                [
                                    {
                                        "url": "ombCategory",
                                        "valueCoding":
                                        {
                                            "system": "urn:oid:2.16.840.1.113883.6.238",
                                            "code": "2186-5",
                                            "display": "Not Hispanic or Latino"
                                        }
                                    },
                                    {
                                        "url": "text",
                                        "valueString": "Not Hispanic or Latino"
                                    }
                                ]
                            },
                            {
                                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
                                "extension":
                                [
                                    {
                                        "url": "tribalAffiliation",
                                        "valueCodeableConcept":
                                        {
                                            "coding":
                                            [
                                                {
                                                    "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                                                    "code": "187",
                                                    "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            },
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/tz-code",
                                "valueCode": "America/New_York"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/clinical-note",
                                "valueString": "I am a clinical caption from a Create message"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/administrative-note",
                                "valueString": "I am an administrative caption from a Create message"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/preferred-pharmacy",
                                "extension":
                                [
                                    {
                                        "url": "ncpdp-id",
                                        "valueIdentifier":
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber",
                                            "value": "1123152"
                                        }
                                    },
                                    {
                                        "url": "specialty_type",
                                        "valueString": "Retail"
                                    },
                                    {
                                        "url": "default",
                                        "valueBoolean": false
                                    }
                                ]
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-provider",
                                "valueReference": {
                                    "reference": "Practitioner/55096fbcdfb240fd8c999c325304de03",
                                    "type": "Practitioner",
                                    "display": "Steven Magee"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/patient-default-location",
                                "valueReference": {
                                    "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                                    "type": "Location",
                                    "display": "Canvas Clinic San Francisco"
                                }
                            }
                        ],
                        "identifier":
                        [
                            {
                                "use": "usual",
                                "type":
                                {
                                    "coding":
                                    [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                                            "code": "MR"
                                        }
                                    ]
                                },
                                "system": "http://canvasmedical.com",
                                "value": "963277285",
                                "assigner":
                                {
                                    "display": "Canvas Medical"
                                }
                            },
                            {
                                "id": "1e628d77-5cdd-400f-a239-b24929d4a0aa",
                                "use": "usual",
                                "system": "HealthCo",
                                "value": "s07960990",
                                "period":
                                {
                                    "start": "1970-01-01",
                                    "end": "2100-12-31"
                                }
                            }
                        ],
                        "active": true,
                        "name":
                        [
                            {
                                "use": "official",
                                "family": "Jones",
                                "given":
                                [
                                    "Samantha",
                                    "Ann"
                                ],
                                "period":
                                {
                                    "start": "0001-01-01T00:00:00+00:00",
                                    "end": "9999-12-31T23:59:59.999999+00:00"
                                }
                            },
                            {
                                "use": "nickname",
                                "given":
                                [
                                    "Sammy"
                                ],
                                "period":
                                {
                                    "start": "0001-01-01T00:00:00+00:00",
                                    "end": "9999-12-31T23:59:59.999999+00:00"
                                }
                            }
                        ],
                        "telecom":
                        [
                            {
                                "id": "aa0d6ad0-0b69-4740-9c8c-759c769a63d1",
                                "extension":
                                [
                                    {
                                        "url": "http://schemas.canvasmedical.com/fhir/extensions/has-consent",
                                        "valueBoolean": false
                                    }
                                ],
                                "system": "phone",
                                "value": "5554320555",
                                "use": "mobile",
                                "rank": 1
                            },
                            {
                                "id": "49c0c29d-c56e-41bb-89ab-79562bb75afc",
                                "extension":
                                [
                                    {
                                        "url": "http://schemas.canvasmedical.com/fhir/extensions/has-consent",
                                        "valueBoolean": false
                                    }
                                ],
                                "system": "email",
                                "value": "samantha.jones@example.com",
                                "use": "work",
                                "rank": 1
                            }
                        ],
                        "gender": "female",
                        "birthDate": "1980-11-13",
                        "deceasedBoolean": false,
                        "address":
                        [
                            {
                                "id": "611aaf01-a515-4d55-b43d-88b8735359f7",
                                "use": "home",
                                "type": "both",
                                "line":
                                [
                                    "1234 Main St."
                                ],
                                "city": "Los Angeles",
                                "state": "CA",
                                "postalCode": "94107",
                                "country": "United States"
                            }
                        ],
                        "contact":
                        [
                            {
                                "id": "1ba81cb4-7f97-429d-b0d8-4c4f067b11a5",
                                "relationship":
                                [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                                "code": "SPS",
                                                "display": "spouse"
                                            },
                                            {
                                                "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                                "code": "ARI",
                                                "display": "Authorized for release of information"
                                            },
                                            {
                                                "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                                "code": "POA",
                                                "display": "Power of attorney"
                                            },
                                            {
                                                "system": "http://schemas.canvasmedical.com/fhir/contact-category",
                                                "code": "EMC",
                                                "display": "Emergency contact"
                                            }
                                        ]
                                    }
                                ],
                                "name":
                                {
                                    "text": "Dan Jones"
                                },
                                "telecom":
                                [
                                    {
                                        "system": "email",
                                        "value": "danjones@example.com"
                                    }
                                ]
                            },
                            {
                                "id": "f259a2b0-6bae-479b-8efe-f9436046cfb3",
                                "relationship":
                                [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                                "code": "MTH",
                                                "display": "mother"
                                            }                                    
                                        ]
                                    }
                                ],
                                "name":
                                {
                                    "text": "Linda Stewart"
                                },
                                "telecom":
                                [
                                    {
                                        "system": "phone",
                                        "value": "5557327068"
                                    }
                                ]
                            },
                            {
                                "id": "30639a10-18c2-4222-8d26-32b2ca36a1bb",
                                "relationship":
                                [
                                    {
                                        "coding": [
                                            {
                                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                                "code": "FTH",
                                                "display": "father"
                                            }
                                        ]
                                    }
                                ],
                                "name":
                                {
                                    "text": "Jimmy Stewart"
                                },
                                "telecom":
                                [
                                    {
                                        "system": "email",
                                        "value": "j.stewart@example.com"
                                    }
                                ]
                            }
                        ],
                        "communication":
                        [
                            {
                                "language":
                                {
                                    "coding":
                                    [
                                        {
                                            "system": "urn:ietf:bcp:47",
                                            "code": "en",
                                            "display": "English"
                                        }
                                    ],
                                    "text": "English"
                                }
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/patient/


----- BEGIN PAGE https://docs.canvasmedical.com/api/paymentnotice/
### 
This resource provides the status of the payment for goods and services rendered, and the request and response resource references.  
<https://hl7.org/fhir/R4/paymentnotice.html>  
In Canvas, FHIR PaymentNotice records payments made toward a patient's balance.  
See this [Zendesk article](https://canvas-medical.help.usepylon.com/articles/3813109228-collect-payment) for information about how to collect payments.
### Endpoints
post /PaymentNotice get /PaymentNotice/{id} get /PaymentNotice
post
/PaymentNotice
#### PaymentNotice create
Create a PaymentNotice resource.  
This endpoint can be used to note a payment that has been collected from a patient and deduct the amount from their balance.  
Moreover, this endpoint can be used to denote copayments as well. For that purpose, use the valueReference extension to link the associated Claim for which the copayment is being processed. Adding that extension determines the purpose of action for this endpoint, meaning that it would be treated as a copayment transaction if the Claim reference extension is present.  
**Don't overpay!** Requests that would bring the account balance negative will be rejected. Example: If a patient owes $5, Canvas would reject a PaymentNotice with a value that is greater than $5. Balance can only go negative if performing copayments as customers could be charged prior to recieveing a medical service.  
A created payment notice can be found in Canvas by going to the patient's chart, and clicking the paper icon in the top right corner. The created payment notice will be displayed under receipts. The "Originator" will be automatically set to Canvas Bot.  
As payment notices are created, they will be applied to charges in chronological order of creation date, from oldest to newest.
### Attributes
id 
string 
The identifier of the payment notice.
extension 
array[json] 
Specific FHIR extensions on resources are supported to be able to map some Canvas specific attributes. The copayment extensions contains references to claims used for copayments.
If you are not denoting a copayment, then use PaymentNotice without the copayment extension for other type of payments.
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/copayment-claims 
extension 
array[json] 
Use this extension to denote and reference a Claim targeted for a copayment. For producing copayments, only a single Claim is accepted.
Click to view child attributes
url 
string required
Identifies the meaning of the extension.
**Value Options Supported:**
  - claim 
valueReference 
json required
Click to view child attributes
reference 
string required
The reference string of the [Claim](/api/claim) used for copayments in the format of `"Claim/f0dfefbe-3fe0-4ee7-bd44-636f7be073e9"`.
status 
string required
The status of the resource instance.
**Value Options Supported:**
  - active 
request 
json required
A reference to the patient whose balance this payment is being applied to.
Click to view child attributes
reference 
string required
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime required
Required by the FHIR spec. Canvas recommends sending the current date on create; however, the value returned by the search interaction will be the creation timestamp of the actual database record in Canvas.
payment 
json required
The `payment` field is required by FHIR, but is not used by Canvas.
Canvas recommends sending an empty JSON object.
recipient 
json required
The `recipient` field is required by FHIR, but is not used by Canvas.
Canvas recommends sending an empty JSON object.
amount 
json required
The payment amount.
Click to view child attributes
value 
decimal 
The amount of USD to apply to the patient's balance.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/PaymentNotice/{id}
#### PaymentNotice read
Read a PaymentNotice resource.
### Path Parameters
id required
string 
The unique identifier for the PaymentNotice   
### Response Payload Attributes
id 
string 
The identifier of the payment notice.
extension 
array[json] 
Specific FHIR extensions on resources are supported to be able to map some Canvas specific attributes. The copayment extensions contains references to claims used for copayments.
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/copayment-claims 
extension 
array[json] 
A nested extension that contains references to Claims related to copayments.
Click to view child attributes
url 
string 
Identifies the meaning of the extension.
**Value Options Supported:**
  - claim 
valueReference 
json 
Click to view child attributes
reference 
string 
The reference string of the [Claim](/api/claim) used for copayments in the format of `"Claim/f0dfefbe-3fe0-4ee7-bd44-636f7be073e9"`.
status 
string 
The status of the resource instance.
**Value Options Supported:**
  - active 
request 
json 
A reference to the patient whose balance this payment is being applied to.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime 
Required by the FHIR spec. Canvas recommends sending the current date on create; however, the value returned by the search interaction will be the creation timestamp of the actual database record in Canvas.
payment 
json 
The `payment` field is required by FHIR, but is not used by Canvas.
Click to view child attributes
display 
Text alternative for the resource.
**Value Options Supported:**
  - unused 
recipient 
json 
The `recipient` field is required by FHIR, but is not used by Canvas.
Click to view child attributes
display 
Text alternative for the resource.
**Value Options Supported:**
  - unused 
amount 
json 
The payment amount.
Click to view child attributes
value 
decimal 
The amount of USD to apply to the patient's balance.
currency 
code 
ISO 4217 Currency Code. Only **USD** is supported, and **USD** will be used regardless of what is provided.
**Value Options Supported:**
  - USD 
paymentStatus 
json 
Issued or cleared Status of the payment.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system. There will be a single coding of **paid**.
Click to view child attributes
system 
string 
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/paymentstatus 
code 
string 
In search responses, the code of **paid** will be noted.
**Value Options Supported:**
  - paid 
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/PaymentNotice
#### PaymentNotice search
Search for PaymentNotice resources.
### Query Parameters
****
_id 
string 
The Canvas-issued unique identifier of the PaymentNotice
request 
string 
The patient reference associated with the PaymentNotice in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
id 
string 
The identifier of the payment notice.
extension 
array[json] 
Specific FHIR extensions on resources are supported to be able to map some Canvas specific attributes. The copayment extensions contains references to claims used for copayments.
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/copayment-claims 
extension 
array[json] 
A nested extension that contains references to Claims related to copayments.
Click to view child attributes
url 
string 
Identifies the meaning of the extension.
**Value Options Supported:**
  - claim 
valueReference 
json 
Click to view child attributes
reference 
string 
The reference string of the [Claim](/api/claim) used for copayments in the format of `"Claim/f0dfefbe-3fe0-4ee7-bd44-636f7be073e9"`.
status 
string 
The status of the resource instance.
**Value Options Supported:**
  - active 
request 
json 
A reference to the patient whose balance this payment is being applied to.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
created 
datetime 
Required by the FHIR spec. Canvas recommends sending the current date on create; however, the value returned by the search interaction will be the creation timestamp of the actual database record in Canvas.
payment 
json 
The `payment` field is required by FHIR, but is not used by Canvas.
Click to view child attributes
display 
Text alternative for the resource.
**Value Options Supported:**
  - unused 
recipient 
json 
The `recipient` field is required by FHIR, but is not used by Canvas.
Click to view child attributes
display 
Text alternative for the resource.
**Value Options Supported:**
  - unused 
amount 
json 
The payment amount.
Click to view child attributes
value 
decimal 
The amount of USD to apply to the patient's balance.
currency 
code 
ISO 4217 Currency Code. Only **USD** is supported, and **USD** will be used regardless of what is provided.
**Value Options Supported:**
  - USD 
paymentStatus 
json 
Issued or cleared Status of the payment.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system. There will be a single coding of **paid**.
Click to view child attributes
system 
string 
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/paymentstatus 
code 
string 
In search responses, the code of **paid** will be noted.
**Value Options Supported:**
  - paid 
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```sh
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/PaymentNotice' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "PaymentNotice",
            "extension": [
                {
                    "extension": [
                        {
                            "url": "claim",
                            "valueReference": {
                                "reference": "Claim/f0dfefbe-3fe0-4ee7-bd44-636f7be073e9"
                            }
                        }
                    ],
                    "url": "http://schemas.canvasmedical.com/fhir/copayment-claims"
                }
            ],
            "status": "active",
            "request": {
                "reference": "Patient/bc4ec998a49745b488f552bebddf7261"
            },
            "created": "2023-09-12",
            "payment": {},
            "recipient": {},
            "amount": {
                "value": 10.00,
                "currency": "USD"
            }
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/PaymentNotice"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "PaymentNotice",
            "extension": [
                {
                    "extension": [
                        {
                            "url": "claim",
                            "valueReference": {
                                "reference": "Claim/f0dfefbe-3fe0-4ee7-bd44-636f7be073e9"
                            }
                        }
                    ],
                    "url": "http://schemas.canvasmedical.com/fhir/copayment-claims"
                }
            ],
            "status": "active",
            "request": {
                "reference": "Patient/bc4ec998a49745b488f552bebddf7261"
            },
            "created": "2023-09-12",
            "payment": {},
            "recipient": {},
            "amount": {
                "value": 10.00,
                "currency": "USD"
            }
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/PaymentNotice/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/PaymentNotice/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "PaymentNotice",
            "id": "297e160c-8246-4054-8023-554d8e14c8c8",
            "extension": [
                {
                    "extension": [
                        {
                            "url": "claim",
                            "valueReference": {
                                "reference": "Claim/f0dfefbe-3fe0-4ee7-bd44-636f7be073e9"
                            }
                        }
                    ],
                    "url": "http://schemas.canvasmedical.com/fhir/copayment-claims"
                }
            ],
            "status": "active",
            "request": {
                "reference": "Patient/3f688bb915d04e168dbfa635da4ab259",
                "type": "Patient"
            },
            "created": "2023-10-17T18:27:59.232743+00:00",
            "payment": {
                "display": "Unused"
            },
            "recipient": {
                "display": "Unused"
            },
            "amount": {
                "value": 25.0,
                "currency": "USD"
            },
            "paymentStatus": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/paymentstatus",
                        "code": "paid"
                    }
                ]
            }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown PaymentNotice resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/PaymentNotice?request=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/PaymentNotice?request=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/PaymentNotice?request=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/PaymentNotice?request=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/PaymentNotice?request=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "PaymentNotice",
                        "id": "777094d2-664c-49b9-8926-b17a1b3fff8d",
                        "status": "active",
                        "request": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                            "type": "Patient"
                        },
                        "created": "2023-09-13T01:10:49.515238+00:00",
                        "payment": {
                            "display": "Unused"
                        },
                        "recipient": {
                            "display": "Unused"
                        },
                        "amount": {
                            "value": 10.0,
                            "currency": "USD"
                        },
                        "paymentStatus": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/paymentstatus",
                                    "code": "paid"
                                }
                            ]
                        }
                    }
                },
                {
                    "resource": {
                        "resourceType": "PaymentNotice",
                        "id": "3a2f4045-0591-460c-9bee-592ae7e8eef7",
                        "extension": [
                            {
                                "extension": [
                                    {
                                        "url": "claim",
                                        "valueReference": {
                                            "reference": "Claim/f0dfefbe-3fe0-4ee7-bd44-636f7be073e9"
                                        }
                                    }
                                ],
                                "url": "http://schemas.canvasmedical.com/fhir/copayment-claims"
                            }
                        ],
                        "status": "active",
                        "request": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                            "type": "Patient"
                        },
                        "created": "2023-09-13T01:11:22.767640+00:00",
                        "payment": {
                            "display": "Unused"
                        },
                        "recipient": {
                            "display": "Unused"
                        },
                        "amount": {
                            "value": 10.0,
                            "currency": "USD"
                        },
                        "paymentStatus": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/paymentstatus",
                                    "code": "paid"
                                }
                            ]
                        }
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/paymentnotice/


----- BEGIN PAGE https://docs.canvasmedical.com/api/practitioner-operations/
##  send-reset-password-email 
Send reset password email to Practitioner by the given ID.  
This endpoint is a [FHIR operation](https://hl7.org/fhir/R4/operations.html), so it accepts a [Parameters](https://hl7.org/fhir/R4/parameters.html) resource in the request body. It doesn't accept any specific parameters but requires a payload that states the resource type. See the request example for more detail.
The bearer token included in requests send to this endpoint must have one of the following scopes:
  - `system/Practitioner.send-reset-password-email`
  - `user/Practitioner.send-reset-password-email`
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Practitioner/<id>/$send-reset-password-email' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Parameters"
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Practitioner/<id>/$send-reset-password-email"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Parameters"
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
----- END PAGE https://docs.canvasmedical.com/api/practitioner-operations/


----- BEGIN PAGE https://docs.canvasmedical.com/api/practitioner/
### 
A person who is directly or indirectly involved in the provisioning of healthcare.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-practitioner.html>  
To create a new staff member manually in the Canvas UI, see this [article](https://canvas-medical.help.usepylon.com/articles/4283873790-add-a-new-staff-member).  
**Related guides:**
  - [Testing Pharmacy Workflows in a Staging Environment](/guides/pharmacy-staging-testing/)
### Endpoints
post /Practitioner get /Practitioner/{id} put /Practitioner/{id} get /Practitioner
post
/Practitioner
#### Practitioner create
Create Practitioner with provided fields and values.
### Attributes
id 
string 
Unique Canvas identifier for this resource.
extension 
array[json] 
Canvas supports specific FHIR extensions on this resource. In order to identify which extension maps to specific fields in Canvas, the url field is used as an exact string match.
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature 
  - http://schemas.canvasmedical.com/fhir/extensions/roles 
valueString 
string 
Value of extension.  
The `valueString` attribute is needed for the role's extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username`.   
A username is a unique and often personalized identifier that an individual or entity uses to access a computer system, online platform, or any other service that requires user authentication
valueUrl 
string 
Value of extension.  
The `valueUrl` attribute is needed for the meeting link extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link`. This value will represent the url that will be associated to any telehealth notes in Canvas.
valueReference 
json 
Value of extension.  
The `valueReference` attribute is needed for the primary location extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location`. This attribute will be the reference the practitioner's primary location they practice at.
Click to view child attributes
reference 
string required
The reference string of the location in the format of `"Location/95b9ac2d-e963-4d7a-b165-7901870f1663"`.
type 
string 
Type the reference refers to (e.g. "Location").
valueAttachment 
json 
Value of extension.  
The `valueAttachment` attribute is needed for the signature extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature`. This attribute represents the attachment of the practitioner's real handwritten signature file.
Click to view child attributes
data 
string required
A base64-encoded file.
extension 
array[json] 
For the Role extensions where the url is `http://schemas.canvasmedical.com/fhir/extensions/roles`, the `extension` attribute is used to define the list of role's this practitioner has at the practice.
Click to view child attributes
url 
string 
Identifies the meaning of the extension.
**Value Options Supported:**
  - code 
valueCoding 
json required
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/roles 
code 
string required
The internal code. Examples of expected values include RN, CA, MA, etc. Some of these values are built in to each Canvas instance but are customizable. See this [article](https://canvas-medical.help.usepylon.com/articles/6649603926-staff-roles) for more information.
display 
string 
The display name of the coding.
identifier 
array[json] 
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/us-npi 
value 
string 
Practitioner's NPI number. Its value must be a 10 digit number.
active 
boolean 
A boolean to specify if the practitioner is active in the healthcare system. If this value is not set, Canvas will default this to true.
name 
array[json] required
The name associated with the practitioner.
Click to view child attributes
use 
enum [ usual ] required
The 'use' attribute specifies the context in which the name is used. For this API, the only permitted value is 'usual,' which indicates that the name provided is the name typically used to identify the practitioner in daily practice.
family 
string required
Practitioner's last name.
given 
array[string] required
Practitioner's first name. Only one first name is allowed.
telecom 
array[json] required
Practitioner contact point(s) (email / phone / fax).   
At least one contact point with the specifications `system`: **phone** and `use`: **work** is required and it is designated as the primary phone for the Practitioner.   
There must be exactly one contact point with the specifications `system`: **email** and `rank`: **1**. An error will be triggered if there is more than one `email` with `rank` set to **1** , however, multiple emails with other ranks (e.g., rank 2, 3, 4, etc.) are allowed.
Click to view child attributes
system 
enum [ phone | fax | email | pager | other ] required
Telecommunications form for contact point - what communications system is required to make use of the contact.
value 
string required
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Values for phone numbers (where "system" is set to "phone") must be only digits, with no sign characters or spaces.
use 
enum [ home | work | temp | old | mobile ] required
Identifies the purpose for the contact point.
rank 
integer required
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
address 
array[json] 
Address(es) of the practitioner entered in Canvas. No default values will be set.
Click to view child attributes
use 
enum [ home | work | temp | old | billing ] required
Defines the purpose of this address.
type 
enum [ both | physical | postal ] required
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
line 
array[string] 
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.  
The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
The name of the city, town, suburb, village or other community or delivery center.
state 
string 
Two-letter state abbreviation of the address.
postalCode 
string 
The 5-digit postal code of the address.
country 
string 
Specifies the country in which the practitioner's address is located. This field typically contains the name of the country, following the ISO 3166 standard.
birthDate 
date required
The date on which the practitioner was born, formatted as YYYY-MM-DD.
photo 
array[json] 
Practitioner photo(s).
Click to view child attributes
url 
string required
Uri where the data can be found.
title 
string 
Label to display in place of the data.
qualification 
array[json] 
Practitioner license(s)
Click to view child attributes
identifier 
array[json] required
This component identifies the issuing authority of the Practitioner's qualification (license).
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url 
value 
string 
The `value` attribute contains the actual identifier assigned to the practitioner's qualification. This value is unique within the context defined by the `system` attribute. It can be any string that serves as a meaningful identifier, such as a license number, certification ID, or other relevant qualification identifiers.
code 
json 
License type coding object. Specifies the type of license that practitioner holds.
Click to view child attributes
text 
string 
The license type code. This field specifies the type of license that practitioner holds.
**Value Options Supported:**
  - CLIA 
  - DEA 
  - PTAN 
  - SPI 
  - STATE 
  - TAXONOMY 
  - OTHER 
period 
json required
A component of the Practitioner's license that defines validity period of the license with starting and the ending dates.
Click to view child attributes
start 
string 
Start date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
end 
string 
End date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
issuer 
json 
A component of the Practitioner's license object that defines the license issuing authority short name.
Click to view child attributes
display 
string 
The display text of the license's short name.
extension 
array[json] 
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name 
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state 
  - http://schemas.canvasmedical.com/fhir/extensions/license-primary 
valueString 
string 
The string value for the extension. Used for issuing authority short name and state extensions.
valueBoolean 
boolean 
The boolean value for the extension. Used for the license-primary extension to indicate if this is the practitioner's primary license.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Practitioner/{id}
#### Practitioner read
Read a Practitioner resource
### Path Parameters
id required
string 
The unique identifier for the Practitioner   
### Response Payload Attributes
id 
string 
Unique Canvas identifier for this resource.
extension 
array[json] 
Canvas supports specific FHIR extensions on this resource.
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature 
  - http://schemas.canvasmedical.com/fhir/extensions/roles 
valueString 
string 
Value of extension.  
The `valueString` attribute is needed for the role's extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username`.   
A username is a unique and often personalized identifier that an individual or entity uses to access a computer system, online platform, or any other service that requires user authentication
valueUrl 
string 
Value of extension.  
The `valueUrl` attribute is needed for the meeting link extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link`. This value will represent the url that will be associated to any telehealth notes in Canvas.
valueReference 
json 
Value of extension.  
The `valueReference` attribute is needed for the primary location extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location`. This attribute will be the reference the practitioner's primary location they practice at.
Click to view child attributes
reference 
string 
The reference string of the location in the format of `"Location/95b9ac2d-e963-4d7a-b165-7901870f1663"`.
type 
string 
Type the reference refers to (e.g. "Location").
valueAttachment 
json 
Value of extension.  
The `valueAttachment` attribute is needed for the signature extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature`. This attribute represents the attachment of the practitioner's real handwritten signature file.
Click to view child attributes
extension 
json 
Extension for backward-compatible URLs
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
extension 
array[json] 
For the Role extensions where the url is `http://schemas.canvasmedical.com/fhir/extensions/roles`, the `extension` attribute is used to define the list of role's this practitioner has at the practice.
Click to view child attributes
url 
string 
Identifies the meaning of the extension.
**Value Options Supported:**
  - code 
valueCoding 
json 
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/roles 
code 
string 
The internal code. Examples of expected values include RN, CA, MA, etc. Some of these values are built in to each Canvas instance but are customizable. See this [article](https://canvas-medical.help.usepylon.com/articles/6649603926-staff-roles) for more information.
display 
string 
The display name of the coding.
identifier 
array[json] 
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/us-npi 
value 
string 
Practitioner's NPI number. Its value must be a 10 digit number.
active 
boolean 
A boolean to specify if the practitioner is active in the healthcare system. If this value is not set, Canvas will default this to true.
name 
array[json] 
The name associated with the practitioner.
Click to view child attributes
use 
enum [ usual ] 
The 'use' attribute specifies the context in which the name is used. For this API, the only permitted value is 'usual,' which indicates that the name provided is the name typically used to identify the practitioner in daily practice.
text 
string 
Text representation of the full name.
family 
string 
Practitioner's last name.
given 
array[string] 
Practitioner's first name. Only one first name is allowed.
prefix 
array[string] 
Parts that come before the name.
suffix 
array[string] 
Parts that come after the name.
telecom 
array[json] 
Practitioner contact point(s) (email / phone / fax).
Click to view child attributes
id 
string 
The identifier (ID) of the telecom (contact point) record in Canvas.
system 
enum [ phone | fax | email | pager | other ] 
Telecommunications form for contact point - what communications system is required to make use of the contact.
value 
string 
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
use 
enum [ home | work | temp | old | mobile ] 
Identifies the purpose for the contact point.
rank 
integer 
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
address 
array[json] 
Address(es) of the practitioner entered in Canvas. No default values will be set.
Click to view child attributes
id 
string 
The identifier (ID) of the address record in Canvas.
use 
enum [ home | work | temp | old | billing ] 
Defines the purpose of this address.
type 
enum [ both | physical | postal ] 
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
line 
array[string] 
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.  
The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
The name of the city, town, suburb, village or other community or delivery center.
state 
string 
Two-letter state abbreviation of the address.
postalCode 
string 
The 5-digit postal code of the address.
country 
string 
Specifies the country in which the practitioner's address is located. This field typically contains the name of the country, following the ISO 3166 standard.
birthDate 
date 
The date on which the practitioner was born, formatted as YYYY-MM-DD.
photo 
array[json] 
Practitioner photo(s).
Click to view child attributes
url 
string 
Uri where the data can be found.
title 
string 
Label to display in place of the data.
qualification 
array[json] 
Practitioner license(s)
Click to view child attributes
identifier 
array[json] 
This component identifies the issuing authority of the Practitioner's qualification (license).
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url 
value 
string 
The `value` attribute contains the actual identifier assigned to the practitioner's qualification. This value is unique within the context defined by the `system` attribute. It can be any string that serves as a meaningful identifier, such as a license number, certification ID, or other relevant qualification identifiers.
code 
json 
License type coding object. Specifies the type of license that practitioner holds.
Click to view child attributes
text 
string 
The license type code. This field specifies the type of license that practitioner holds.
**Value Options Supported:**
  - CLIA 
  - DEA 
  - PTAN 
  - SPI 
  - STATE 
  - TAXONOMY 
  - OTHER 
period 
json 
A component of the Practitioner's license that defines validity period of the license with starting and the ending dates.
Click to view child attributes
start 
string 
Start date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
end 
string 
End date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
issuer 
json 
A component of the Practitioner's license object that defines the license issuing authority short name.
Click to view child attributes
display 
string 
The display text of the license's short name.
extension 
array[json] 
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name 
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state 
  - http://schemas.canvasmedical.com/fhir/extensions/license-primary 
valueString 
string 
The string value for the extension. Used for issuing authority short name and state extensions.
valueBoolean 
boolean 
The boolean value for the extension. Used for the license-primary extension to indicate if this is the practitioner's primary license.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Practitioner/{id}
#### Practitioner update
Update Practitioner with provided fields and values.
### Attributes
id 
string required
Unique Canvas identifier for this resource.
extension 
array[json] 
Canvas supports specific FHIR extensions on this resource. In order to identify which extension maps to specific fields in Canvas, the url field is used as an exact string match.  
During updates, When an extension is omitted from the payload request, it will be considered as an intention to remove the value stored associated to that field, thus their values will be deleted in Canvas. The only exception is the username extension, which remains unchanged and this API will return error if the update request is trying to change the Practitioner's (Staff) username.
Click to view child attributes
url 
string required
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature 
  - http://schemas.canvasmedical.com/fhir/extensions/roles 
valueString 
string 
Value of extension.  
The `valueString` attribute is needed for the role's extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username`.   
A username is a unique and often personalized identifier that an individual or entity uses to access a computer system, online platform, or any other service that requires user authentication
valueUrl 
string 
Value of extension.  
The `valueUrl` attribute is needed for the meeting link extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link`. This value will represent the url that will be associated to any telehealth notes in Canvas.
valueReference 
json 
Value of extension.  
The `valueReference` attribute is needed for the primary location extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location`. This attribute will be the reference the practitioner's primary location they practice at.
Click to view child attributes
reference 
string 
The reference string of the location in the format of `"Location/95b9ac2d-e963-4d7a-b165-7901870f1663"`.
type 
string 
Type the reference refers to (e.g. "Location").
valueAttachment 
json 
Value of extension.  
The `valueAttachment` attribute is needed for the signature extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature`. This attribute represents the attachment of the practitioner's real handwritten signature file.
Click to view child attributes
data 
string 
A base64-encoded file.
extension 
array[json] 
For the Role extensions where the url is `http://schemas.canvasmedical.com/fhir/extensions/roles`, the `extension` attribute is used to define the list of role's this practitioner has at the practice.
Click to view child attributes
url 
string 
Identifies the meaning of the extension.
**Value Options Supported:**
  - code 
valueCoding 
json required
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/roles 
code 
string required
The internal code. Examples of expected values include RN, CA, MA, etc. Some of these values are built in to each Canvas instance but are customizable. See this [article](https://canvas-medical.help.usepylon.com/articles/6649603926-staff-roles) for more information.
display 
string 
The display name of the coding.
identifier 
array[json] 
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/us-npi 
value 
string 
Practitioner's NPI number. Its value must be a 10 digit number.
active 
boolean 
A boolean to specify if the practitioner is active in the healthcare system. If this value is not set, Canvas will default this to true.
name 
array[json] required
The name associated with the practitioner.
Click to view child attributes
use 
enum [ usual ] required
The 'use' attribute specifies the context in which the name is used. For this API, the only permitted value is 'usual,' which indicates that the name provided is the name typically used to identify the practitioner in daily practice.
family 
string required
Practitioner's last name.
given 
array[string] required
Practitioner's first name. Only one first name is allowed.
telecom 
array[json] required
Practitioner contact point(s) (email / phone / fax).   
At least one contact point with the specifications `system`: **phone** and `use`: **work** is required as the primary phone for the Practitioner.   
There must be exactly one contact point with the specifications `system`: **email** and `rank`: **1**. An error will be triggered if there is more than one `email` with `rank` set to **1** , however, multiple emails with other ranks (e.g., rank 2, 3, 4, etc.) are allowed.   
**IMPORTANT** : Updating email contact points is not permitted. During updates, the values must remain unchanged from the original creation or retrieval.
Click to view child attributes
id 
string 
The identifier (ID) of the telecom (contact point) record in Canvas.   
If you want to update a specific telecom record in Canvas, use this property to target that record.   
If you omit "id" during update, a new telecom record will be created.
system 
enum [ phone | fax | email | pager | other ] required
Telecommunications form for contact point - what communications system is required to make use of the contact.
value 
string required
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Values for phone numbers (where "system" is set to "phone") must be only digits, with no sign characters or spaces.
use 
enum [ home | work | temp | old | mobile ] required
Identifies the purpose for the contact point.
rank 
integer required
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
address 
array[json] 
Address(es) of the practitioner entered in Canvas. No default values will be set.
Click to view child attributes
id 
string 
The identifier (ID) of the address record in Canvas.   
If you want to update a specific address record in Canvas, use this property to target that record.   
If you omit "id" during update, a new address record will be created.
use 
enum [ home | work | temp | old | billing ] required
Defines the purpose of this address.
type 
enum [ both | physical | postal ] required
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
line 
array[string] 
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.  
The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
The name of the city, town, suburb, village or other community or delivery center.
state 
string 
Two-letter state abbreviation of the address.
postalCode 
string 
The 5-digit postal code of the address.
country 
string 
Specifies the country in which the practitioner's address is located. This field typically contains the name of the country, following the ISO 3166 standard.
birthDate 
date required
The date on which the practitioner was born, formatted as YYYY-MM-DD.
photo 
array[json] 
Practitioner photo(s).
Click to view child attributes
url 
string required
Uri where the data can be found.
title 
string 
Label to display in place of the data.
qualification 
array[json] 
Practitioner license(s)
Click to view child attributes
identifier 
array[json] required
This component identifies the issuing authority of the Practitioner's qualification (license).
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url 
value 
string 
The `value` attribute contains the actual identifier assigned to the practitioner's qualification. This value is unique within the context defined by the `system` attribute. It can be any string that serves as a meaningful identifier, such as a license number, certification ID, or other relevant qualification identifiers.
code 
json 
License type coding object. Specifies the type of license that practitioner holds.
Click to view child attributes
text 
string 
The license type code. This field specifies the type of license that practitioner holds.
**Value Options Supported:**
  - CLIA 
  - DEA 
  - PTAN 
  - SPI 
  - STATE 
  - TAXONOMY 
  - OTHER 
period 
json required
A component of the Practitioner's license that defines validity period of the license with starting and the ending dates.
Click to view child attributes
start 
string 
Start date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
end 
string 
End date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
issuer 
json 
A component of the Practitioner's license object that defines the license issuing authority short name.
Click to view child attributes
display 
string 
The display text of the license's short name.
extension 
array[json] 
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name 
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state 
  - http://schemas.canvasmedical.com/fhir/extensions/license-primary 
valueString 
string 
The string value for the extension. Used for issuing authority short name and state extensions.
valueBoolean 
boolean 
The boolean value for the extension. Used for the license-primary extension to indicate if this is the practitioner's primary license.
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Practitioner
#### Practitioner search
Search for Practitioner resources
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier
include-non-schedulable-practitioners 
boolean 
By default, only schedulable practitioners are displayed. Passing this parameter as "true" will return both schedulable and non-schedulable practitioners.
active 
string 
Search by `active` status ("true" or "false" - case insensitive). By default if this param is not present, it will return practitioners with `active` set to True ("true").
name 
string 
A search that may match any of the string fields in the name, including `family`, `given`, `prefix`, `suffix`, and/or `text`. Partial search is supported.
email 
string 
Practitioner user email.
npi-number 
string 
Practitioner NPI number.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
id 
string 
Unique Canvas identifier for this resource.
extension 
array[json] 
Canvas supports specific FHIR extensions on this resource.
Click to view child attributes
url 
string 
Identifies the meaning of the extension
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location 
  - http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature 
  - http://schemas.canvasmedical.com/fhir/extensions/roles 
valueString 
string 
Value of extension.  
The `valueString` attribute is needed for the role's extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username`.   
A username is a unique and often personalized identifier that an individual or entity uses to access a computer system, online platform, or any other service that requires user authentication
valueUrl 
string 
Value of extension.  
The `valueUrl` attribute is needed for the meeting link extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link`. This value will represent the url that will be associated to any telehealth notes in Canvas.
valueReference 
json 
Value of extension.  
The `valueReference` attribute is needed for the primary location extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location`. This attribute will be the reference the practitioner's primary location they practice at.
Click to view child attributes
reference 
string 
The reference string of the location in the format of `"Location/95b9ac2d-e963-4d7a-b165-7901870f1663"`.
type 
string 
Type the reference refers to (e.g. "Location").
valueAttachment 
json 
Value of extension.  
The `valueAttachment` attribute is needed for the signature extension where the `url` is `http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature`. This attribute represents the attachment of the practitioner's real handwritten signature file.
Click to view child attributes
extension 
json 
Extension for backward-compatible URLs
url 
string 
URI where the data can be found. This URL requires a Bearer token and returns a redirect to a pre-signed S3 URL. See [Accessing Resource Attachment Files](/api/accessing-resource-attachment-files) for details on how to access the file.
extension 
array[json] 
For the Role extensions where the url is `http://schemas.canvasmedical.com/fhir/extensions/roles`, the `extension` attribute is used to define the list of role's this practitioner has at the practice.
Click to view child attributes
url 
string 
Identifies the meaning of the extension.
**Value Options Supported:**
  - code 
valueCoding 
json 
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/roles 
code 
string 
The internal code. Examples of expected values include RN, CA, MA, etc. Some of these values are built in to each Canvas instance but are customizable. See this [article](https://canvas-medical.help.usepylon.com/articles/6649603926-staff-roles) for more information.
display 
string 
The display name of the coding.
identifier 
array[json] 
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://hl7.org/fhir/sid/us-npi 
value 
string 
Practitioner's NPI number. Its value must be a 10 digit number.
active 
boolean 
A boolean to specify if the practitioner is active in the healthcare system. If this value is not set, Canvas will default this to true.
name 
array[json] 
The name associated with the practitioner.
Click to view child attributes
use 
enum [ usual ] 
The 'use' attribute specifies the context in which the name is used. For this API, the only permitted value is 'usual,' which indicates that the name provided is the name typically used to identify the practitioner in daily practice.
text 
string 
Text representation of the full name.
family 
string 
Practitioner's last name.
given 
array[string] 
Practitioner's first name. Only one first name is allowed.
prefix 
array[string] 
Parts that come before the name.
suffix 
array[string] 
Parts that come after the name.
telecom 
array[json] 
Practitioner contact point(s) (email / phone / fax).
Click to view child attributes
id 
string 
The identifier (ID) of the telecom (contact point) record in Canvas.
system 
enum [ phone | fax | email | pager | other ] 
Telecommunications form for contact point - what communications system is required to make use of the contact.
value 
string 
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
use 
enum [ home | work | temp | old | mobile ] 
Identifies the purpose for the contact point.
rank 
integer 
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
address 
array[json] 
Address(es) of the practitioner entered in Canvas. No default values will be set.
Click to view child attributes
id 
string 
The identifier (ID) of the address record in Canvas.
use 
enum [ home | work | temp | old | billing ] 
Defines the purpose of this address.
type 
enum [ both | physical | postal ] 
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
line 
array[string] 
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.  
The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
The name of the city, town, suburb, village or other community or delivery center.
state 
string 
Two-letter state abbreviation of the address.
postalCode 
string 
The 5-digit postal code of the address.
country 
string 
Specifies the country in which the practitioner's address is located. This field typically contains the name of the country, following the ISO 3166 standard.
birthDate 
date 
The date on which the practitioner was born, formatted as YYYY-MM-DD.
photo 
array[json] 
Practitioner photo(s).
Click to view child attributes
url 
string 
Uri where the data can be found.
title 
string 
Label to display in place of the data.
qualification 
array[json] 
Practitioner license(s)
Click to view child attributes
identifier 
array[json] 
This component identifies the issuing authority of the Practitioner's qualification (license).
Click to view child attributes
system 
string 
The `system` attribute specifies the namespace in which the identifier value is unique.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url 
value 
string 
The `value` attribute contains the actual identifier assigned to the practitioner's qualification. This value is unique within the context defined by the `system` attribute. It can be any string that serves as a meaningful identifier, such as a license number, certification ID, or other relevant qualification identifiers.
code 
json 
License type coding object. Specifies the type of license that practitioner holds.
Click to view child attributes
text 
string 
The license type code. This field specifies the type of license that practitioner holds.
**Value Options Supported:**
  - CLIA 
  - DEA 
  - PTAN 
  - SPI 
  - STATE 
  - TAXONOMY 
  - OTHER 
period 
json 
A component of the Practitioner's license that defines validity period of the license with starting and the ending dates.
Click to view child attributes
start 
string 
Start date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
end 
string 
End date of the Practitioner's license. Expected date format is YYYY-MM-DD (Example - "2020-01-01")
issuer 
json 
A component of the Practitioner's license object that defines the license issuing authority short name.
Click to view child attributes
display 
string 
The display text of the license's short name.
extension 
array[json] 
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name 
  - http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state 
  - http://schemas.canvasmedical.com/fhir/extensions/license-primary 
valueString 
string 
The string value for the extension. Used for issuing authority short name and state extensions.
valueBoolean 
boolean 
The boolean value for the extension. Used for the license-primary extension to indicate if this is the practitioner's primary license.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```sh
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Practitioner' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Practitioner",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username",
                    "valueString": "username123"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link",
                    "valueUrl": "https://meet.google.com/room-001"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature",
                    "valueAttachment": {
                        "data": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyAzMiBUZiggIFlPVVIgVEVYVCBIRVJFICAgKScgRVQKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8Ci9UeXBlIC9QYWdlCi9QYXJlbnQgNSAwIFIKL0NvbnRlbnRzIDkgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwovTWVkaWFCb3ggWyAwIDAgMjUwIDUwIF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/roles",
                    "extension": [
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "RN"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "MA"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "CC"
                            }
                        }
                    ]
                }
            ],
            "identifier": [
                {
                    "system": "http://hl7.org/fhir/sid/us-npi",
                    "value": "1920301155"
                }
            ],
            "active": true,
            "name": [
                {
                    "use": "usual",
                    "family": "Jones",
                    "given": [
                        "Samantha"
                    ]
                }
            ],
            "telecom": [
                {
                    "system": "phone",
                    "value": "5558675309",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "system": "phone",
                    "value": "5551234567",
                    "use": "work",
                    "rank": 1
                },
                {
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                }
            ],
            "address": [
                {
                    "use": "work",
                    "type": "both",
                    "line": [
                        "1234 Main St"
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107",
                    "country": "United States"
                },
                {
                    "use": "work",
                    "type": "both",
                    "line": [
                        "12 Cesar Chavez St"
                    ],
                    "city": "San Francisco",
                    "state": "CA",
                    "postalCode": "94110",
                    "country": "United States"
                }
            ],
            "birthDate": "1988-10-10",
            "photo": [
                {
                    "url": "https://fastly.picsum.photos/id/1064/200/300.jpg?hmac=Joir_QEJYjd2_bmYco64ek_C2TSsfReMcWWcXYsObKI",
                    "title": "Profile photo 1 -- sample title"
                },
                {
                    "url": "https://fastly.picsum.photos/id/674/200/300.jpg?hmac=kS3VQkm7AuZdYJGUABZGmnNj_3KtZ6Twgb5Qb9ITssY"
                }
            ],
            "qualification": [
                {
                    "identifier": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url",
                            "value": "PRT-01"
                        }
                    ],
                    "code": {
                        "text": "License"
                    },
                    "period": {
                        "start": "2020-01-01",
                        "end": "2024-05-05"
                    },
                    "issuer": {
                        "display": "MD University Los Angeles",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name",
                                "valueString": "MDU LA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state",
                                "valueString": "CA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/license-primary",
                                "valueBoolean": true
                            }
                        ]
                    }
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Practitioner"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Practitioner",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username",
                    "valueString": "username123"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link",
                    "valueUrl": "https://meet.google.com/room-001"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature",
                    "valueAttachment": {
                        "data": "JVBERi0xLjIgCjkgMCBvYmoKPDwKPj4Kc3RyZWFtCkJULyAzMiBUZiggIFlPVVIgVEVYVCBIRVJFICAgKScgRVQKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8Ci9UeXBlIC9QYWdlCi9QYXJlbnQgNSAwIFIKL0NvbnRlbnRzIDkgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwovTWVkaWFCb3ggWyAwIDAgMjUwIDUwIF0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1BhZ2VzIDUgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iagp0cmFpbGVyCjw8Ci9Sb290IDMgMCBSCj4+CiUlRU9G"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/roles",
                    "extension": [
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "RN"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "MA"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "CC"
                            }
                        }
                    ]
                }
            ],
            "identifier": [
                {
                    "system": "http://hl7.org/fhir/sid/us-npi",
                    "value": "1920301155"
                }
            ],
            "active": True,
            "name": [
                {
                    "use": "usual",
                    "family": "Jones",
                    "given": [
                        "Samantha"
                    ]
                }
            ],
            "telecom": [
                {
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "system": "phone",
                    "value": "333555",
                    "use": "work",
                    "rank": 1
                },
                {
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                },
                {
                    "system": "email",
                    "value": "samantha.jones2@example.com",
                    "use": "work",
                    "rank": 2
                }
            ],
            "address": [
                {
                    "use": "work",
                    "line": [
                        "1234 Main St"
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107",
                    "country": "United States"
                },
                {
                    "use": "work",
                    "line": [
                        "12 Cesar Chavez St"
                    ],
                    "city": "San Francisco",
                    "state": "CA",
                    "postalCode": "94110",
                    "country": "United States"
                }
            ],
            "birthDate": "1988-10-10",
            "photo": [
                {
                    "url": "https://fastly.picsum.photos/id/1064/200/300.jpg?hmac=Joir_QEJYjd2_bmYco64ek_C2TSsfReMcWWcXYsObKI",
                    "title": "Profile photo 1 -- sample title"
                },
                {
                    "url": "https://fastly.picsum.photos/id/674/200/300.jpg?hmac=kS3VQkm7AuZdYJGUABZGmnNj_3KtZ6Twgb5Qb9ITssY"
                }
            ],
            "qualification": [
                {
                    "identifier": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url",
                            "value": "PRT-01"
                        }
                    ],
                    "code": {
                        "text": "License"
                    },
                    "period": {
                        "start": "2020-01-01",
                        "end": "2024-05-05"
                    },
                    "issuer": {
                        "display": "MD University Los Angeles",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name",
                                "valueString": "MDU LA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state",
                                "valueString": "CA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/license-primary",
                                "valueBoolean": True
                            }
                        ]
                    }
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Practitioner/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Practitioner/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Practitioner",
            "id": "55096fbcdfb240fd8c999c325304de03",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username",
                    "valueString": "username123"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link",
                    "valueUrl": "https://meet.google.com/room-001"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location",
                        "display": "Canvas Clinic San Francisco"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature",
                    "valueAttachment": {
                        "url": "https://fumage-example.canvasmedical.com/Practitioner/55096fbcdfb240fd8c999c325304de03/files/signature"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/roles",
                    "extension": [
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "RN"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "MA"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "CC"
                            }
                        }
                    ]
                }
            ],
            "identifier": [
                {
                    "system": "http://hl7.org/fhir/sid/us-npi",
                    "value": "1920301155"
                }
            ],
            "active": true,
            "name": [
                {
                    "use": "usual",
                    "text": "Samantha Jones",
                    "family": "Jones",
                    "given": [
                        "Samantha"
                    ]
                }
            ],
            "telecom": [
                {
                    "id": "4fb49223-3d48-4bd6-8125-2ac62208efd6",
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "id": "1a7f5403-2d9e-4156-a6e0-16c816e873fd",
                    "system": "phone",
                    "value": "333555",
                    "use": "work",
                    "rank": 1
                },
                {
                    "id": "2d9490aa-ed57-46ef-8eec-ed5f22c38844",
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                },
                {
                    "id": "4b8369cf-67e7-404d-8abe-51ff6e9ac835",
                    "system": "email",
                    "value": "samantha.jones2@example.com",
                    "use": "work",
                    "rank": 2
                }
            ],
            "address": [
                {
                    "id": "5e76df8f-36c1-489a-8034-0916c7e8829f",
                    "use": "work",
                    "line": [
                        "1234 Main St"
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107",
                    "country": "United States"
                },
                {
                    "id": "33fe0a8f-1140-4ee3-b703-1afe42e8a3d6",
                    "use": "work",
                    "line": [
                        "12 Cesar Chavez St"
                    ],
                    "city": "San Francisco",
                    "state": "CA",
                    "postalCode": "94110",
                    "country": "United States"
                }
            ],
            "birthDate": "1988-10-10",
            "photo": [
                {
                    "url": "https://fastly.picsum.photos/id/1064/200/300.jpg?hmac=Joir_QEJYjd2_bmYco64ek_C2TSsfReMcWWcXYsObKI",
                    "title": "Profile photo 1 -- sample title"
                },
                {
                    "url": "https://fastly.picsum.photos/id/674/200/300.jpg?hmac=kS3VQkm7AuZdYJGUABZGmnNj_3KtZ6Twgb5Qb9ITssY"
                }
            ],
            "qualification": [
                {
                    "identifier": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url",
                            "value": "PRT-01"
                        }
                    ],
                    "code": {
                        "text": "License"
                    },
                    "period": {
                        "start": "2020-01-01",
                        "end": "2024-05-05"
                    },
                    "issuer": {
                        "display": "MD University Los Angeles",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name",
                                "valueString": "MDU LA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state",
                                "valueString": "CA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/license-primary",
                                "valueBoolean": true
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
            "resourceType": "OperationOutcome",
            "issue": [
                {
                    "severity": "error",
                    "code": "not-found",
                    "details": {
                        "text": "Unknown Practitioner resource '7d1ce256fcd7408193b0459650937a07'"
                    }
                }
            ]
        }
        ```
  - **curl**
        ```sh
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Practitioner/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Practitioner",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link",
                    "valueUrl": "https://meet.google.com/room-001"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature",
                    "valueAttachment": {
                        "url": "https://canvas-client-media.s3.amazonaws.com/local/signature-cdfkizrj.pdf?AWSAccessKeyId=AKIA5KJ2QWTAU572JXPZ&Signature=ljyujvD4fkgOG7b3SxlIokdDIlQ%3D&Expires=1703596102"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/roles",
                    "extension": [
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "RN"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "MA"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "CC"
                            }
                        }
                    ]
                }
            ],
            "identifier": [
                {
                    "system": "http://hl7.org/fhir/sid/us-npi",
                    "value": "1920301155"
                }
            ],
            "active": true,
            "name": [
                {
                    "use": "usual",
                    "text": "Samantha Jones",
                    "family": "Jones",
                    "given": [
                        "Samantha"
                    ]
                }
            ],
            "telecom": [
                {
                    "id": "4fb49223-3d48-4bd6-8125-2ac62208efd6",
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "id": "1a7f5403-2d9e-4156-a6e0-16c816e873fd",
                    "system": "phone",
                    "value": "333555",
                    "use": "work",
                    "rank": 1
                },
                {
                    "id": "2d9490aa-ed57-46ef-8eec-ed5f22c38844",
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                },
                {
                    "id": "4b8369cf-67e7-404d-8abe-51ff6e9ac835",
                    "system": "email",
                    "value": "samantha.jones2@example.com",
                    "use": "work",
                    "rank": 2
                }
            ],
            "address": [
                {
                    "id": "5e76df8f-36c1-489a-8034-0916c7e8829f",
                    "use": "work",
                    "line": [
                        "1234 Main St"
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107",
                    "country": "United States"
                },
                {
                    "id": "33fe0a8f-1140-4ee3-b703-1afe42e8a3d6",
                    "use": "work",
                    "line": [
                        "12 Cesar Chavez St"
                    ],
                    "city": "San Francisco",
                    "state": "CA",
                    "postalCode": "94110",
                    "country": "United States"
                }
            ],
            "birthDate": "1988-10-10",
            "photo": [
                {
                    "url": "https://fastly.picsum.photos/id/1064/200/300.jpg?hmac=Joir_QEJYjd2_bmYco64ek_C2TSsfReMcWWcXYsObKI",
                    "title": "Profile photo 1 -- sample title"
                },
                {
                    "url": "https://fastly.picsum.photos/id/674/200/300.jpg?hmac=kS3VQkm7AuZdYJGUABZGmnNj_3KtZ6Twgb5Qb9ITssY"
                }
            ],
            "qualification": [
                {
                    "identifier": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url",
                            "value": "PRT-01"
                        }
                    ],
                    "code": {
                        "text": "License"
                    },
                    "period": {
                        "start": "2020-01-01",
                        "end": "2024-05-05"
                    },
                    "issuer": {
                        "display": "MD University Los Angeles",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name",
                                "valueString": "MDU LA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state",
                                "valueString": "CA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/license-primary",
                                "valueBoolean": true
                            }
                        ]
                    }
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Practitioner/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "Practitioner",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link",
                    "valueUrl": "https://meet.google.com/room-001"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location",
                    "valueReference": {
                        "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                        "type": "Location"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature",
                    "valueAttachment": {
                        "url": "https://canvas-client-media.s3.amazonaws.com/local/signature-cdfkizrj.pdf?AWSAccessKeyId=AKIA5KJ2QWTAU572JXPZ&Signature=ljyujvD4fkgOG7b3SxlIokdDIlQ%3D&Expires=1703596102"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/roles",
                    "extension": [
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "RN"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "MA"
                            }
                        },
                        {
                            "url": "code",
                            "valueCoding": {
                                "system": "http://schemas.canvasmedical.com/fhir/roles",
                                "code": "CC"
                            }
                        }
                    ]
                }
            ],
            "identifier": [
                {
                    "system": "http://hl7.org/fhir/sid/us-npi",
                    "value": "1920301155"
                }
            ],
            "active": True,
            "name": [
                {
                    "use": "usual",
                    "family": "Jones",
                    "given": [
                        "Samantha"
                    ]
                }
            ],
            "telecom": [
                {
                    "id": "4fb49223-3d48-4bd6-8125-2ac62208efd6",
                    "system": "phone",
                    "value": "5554320555",
                    "use": "mobile",
                    "rank": 1
                },
                {
                    "id": "1a7f5403-2d9e-4156-a6e0-16c816e873fd",
                    "system": "phone",
                    "value": "333555",
                    "use": "work",
                    "rank": 1
                },
                {
                    "id": "2d9490aa-ed57-46ef-8eec-ed5f22c38844",
                    "system": "email",
                    "value": "samantha.jones@example.com",
                    "use": "work",
                    "rank": 1
                },
                {
                    "id": "4b8369cf-67e7-404d-8abe-51ff6e9ac835",
                    "system": "email",
                    "value": "samantha.jones2@example.com",
                    "use": "work",
                    "rank": 2
                }
            ],
            "address": [
                {
                    "id": "5e76df8f-36c1-489a-8034-0916c7e8829f",
                    "use": "work",
                    "line": [
                        "1234 Main St"
                    ],
                    "city": "Los Angeles",
                    "state": "CA",
                    "postalCode": "94107",
                    "country": "United States"
                },
                {
                    "id": "33fe0a8f-1140-4ee3-b703-1afe42e8a3d6",
                    "use": "work",
                    "line": [
                        "12 Cesar Chavez St"
                    ],
                    "city": "San Francisco",
                    "state": "CA",
                    "postalCode": "94110",
                    "country": "United States"
                }
            ],
            "birthDate": "1988-10-10",
            "photo": [
                {
                    "url": "https://fastly.picsum.photos/id/1064/200/300.jpg?hmac=Joir_QEJYjd2_bmYco64ek_C2TSsfReMcWWcXYsObKI",
                    "title": "Profile photo 1 -- sample title"
                },
                {
                    "url": "https://fastly.picsum.photos/id/674/200/300.jpg?hmac=kS3VQkm7AuZdYJGUABZGmnNj_3KtZ6Twgb5Qb9ITssY"
                }
            ],
            "qualification": [
                {
                    "identifier": [
                        {
                            "system": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url",
                            "value": "PRT-01"
                        }
                    ],
                    "code": {
                        "text": "License"
                    },
                    "period": {
                        "start": "2020-01-01",
                        "end": "2024-05-05"
                    },
                    "issuer": {
                        "display": "MD University Los Angeles",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name",
                                "valueString": "MDU LA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state",
                                "valueString": "CA"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/license-primary",
                                "valueBoolean": True
                            }
                        ]
                    }
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown  resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Practitioner?name=Samantha' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Practitioner?name=Samantha"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Practitioner?_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Practitioner?_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Practitioner?_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Practitioner",
                        "id": "55096fbcdfb240fd8c999c325304de03",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-user-username",
                                "valueString": "username123"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-personal-meeting-room-link",
                                "valueUrl": "https://meet.google.com/room-001"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-primary-practice-location",
                                "valueReference": {
                                    "reference": "Location/95b9ac2d-e963-4d7a-b165-7901870f1663",
                                    "type": "Location",
                                    "display": "Canvas Clinic San Francisco"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/practitioner-signature",
                                "valueAttachment": {
                                    "url": "https://fumage-example.canvasmedical.com/Practitioner/55096fbcdfb240fd8c999c325304de03/files/signature"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/roles",
                                "extension": [
                                    {
                                        "url": "code",
                                        "valueCoding": {
                                            "system": "http://schemas.canvasmedical.com/fhir/roles",
                                            "code": "RN"
                                        }
                                    },
                                    {
                                        "url": "code",
                                        "valueCoding": {
                                            "system": "http://schemas.canvasmedical.com/fhir/roles",
                                            "code": "MA"
                                        }
                                    },
                                    {
                                        "url": "code",
                                        "valueCoding": {
                                            "system": "http://schemas.canvasmedical.com/fhir/roles",
                                            "code": "CC"
                                        }
                                    }
                                ]
                            }
                        ],
                        "identifier": [
                            {
                                "system": "http://hl7.org/fhir/sid/us-npi",
                                "value": "1920301155"
                            }
                        ],
                        "active": true,
                        "name": [
                            {
                                "use": "usual",
                                "text": "Samantha Jones",
                                "family": "Jones",
                                "given": [
                                    "Samantha"
                                ]
                            }
                        ],
                        "telecom": [
                            {
                                "id": "4fb49223-3d48-4bd6-8125-2ac62208efd6",
                                "system": "phone",
                                "value": "5554320555",
                                "use": "mobile",
                                "rank": 1
                            },
                            {
                                "id": "1a7f5403-2d9e-4156-a6e0-16c816e873fd",
                                "system": "phone",
                                "value": "333555",
                                "use": "work",
                                "rank": 1
                            },
                            {
                                "id": "2d9490aa-ed57-46ef-8eec-ed5f22c38844",
                                "system": "email",
                                "value": "samantha.jones@example.com",
                                "use": "work",
                                "rank": 1
                            },
                            {
                                "id": "4b8369cf-67e7-404d-8abe-51ff6e9ac835",
                                "system": "email",
                                "value": "samantha.jones2@example.com",
                                "use": "work",
                                "rank": 2
                            }
                        ],
                        "address": [
                            {
                                "id": "5e76df8f-36c1-489a-8034-0916c7e8829f",
                                "use": "work",
                                "line": [
                                    "1234 Main St"
                                ],
                                "city": "Los Angeles",
                                "state": "CA",
                                "postalCode": "94107",
                                "country": "United States"
                            },
                            {
                                "id": "33fe0a8f-1140-4ee3-b703-1afe42e8a3d6",
                                "use": "work",
                                "line": [
                                    "12 Cesar Chavez St"
                                ],
                                "city": "San Francisco",
                                "state": "CA",
                                "postalCode": "94110",
                                "country": "United States"
                            }
                        ],
                        "birthDate": "1988-10-10",
                        "photo": [
                            {
                                "url": "https://fastly.picsum.photos/id/1064/200/300.jpg?hmac=Joir_QEJYjd2_bmYco64ek_C2TSsfReMcWWcXYsObKI",
                                "title": "Profile photo 1 -- sample title"
                            },
                            {
                                "url": "https://fastly.picsum.photos/id/674/200/300.jpg?hmac=kS3VQkm7AuZdYJGUABZGmnNj_3KtZ6Twgb5Qb9ITssY"
                            }
                        ],
                        "qualification": [
                            {
                                "identifier": [
                                    {
                                        "system": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-url",
                                        "value": "PRT-01"
                                    }
                                ],
                                "code": {
                                    "text": "License"
                                },
                                "period": {
                                    "start": "2020-01-01",
                                    "end": "2024-05-05"
                                },
                                "issuer": {
                                    "display": "MD University Los Angeles",
                                    "extension": [
                                        {
                                            "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-short-name",
                                            "valueString": "MDU LA"
                                        },
                                        {
                                            "url": "http://schemas.canvasmedical.com/fhir/extensions/issuing-authority-state",
                                            "valueString": "CA"
                                        },
                                        {
                                            "url": "http://schemas.canvasmedical.com/fhir/extensions/license-primary",
                                            "valueBoolean": true
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/practitioner/


----- BEGIN PAGE https://docs.canvasmedical.com/api/procedure/
### 
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-procedure.html>  
See this [Zendesk article](https://canvas-medical.help.usepylon.com/articles/5988007695-command-perform) for information on creating procedures with the `Perform` command.
### Endpoints
get /Procedure/{id} get /Procedure
get
/Procedure/{id}
#### Procedure read
Read an Procedure resource.
### Path Parameters
id required
string 
The unique identifier for the Procedure   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Procedure.
basedOn 
array[json] 
A reference to a resource that contains details of the request for this procedure.
Click to view child attributes
reference 
string 
The reference string of the ServiceRequest in the format of `"ServiceRequest/a47c7b0e-bbb4-42cd-bc4a-df259d148ea1"`.
type 
string 
Type the reference refers to (e.g. "ServiceRequest").
status 
enum [ in-progress | stopped | completed | unknown | entered-in-error ] 
A code specifying the state of the procedure.
code 
json 
Identification of the procedure.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.ama-assn.org/go/cpt 
  - unstructured 
code 
string 
The code of the procedure.
display 
string 
The display name of the coding.
subject 
json 
Who the procedure was performed on
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
performedDateTime 
datetime 
When the procedure was performed.   
In Canvas, this will be the datetime of service of the note the Perform command is committed to.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Procedure
#### Procedure search
Search for Procedure resources.
### Query Parameters
****
_id 
string 
The identifier of the Procedure.
patient 
string 
The patient reference of whom the procedure was performed on in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Procedure.
basedOn 
array[json] 
A reference to a resource that contains details of the request for this procedure.
Click to view child attributes
reference 
string 
The reference string of the ServiceRequest in the format of `"ServiceRequest/a47c7b0e-bbb4-42cd-bc4a-df259d148ea1"`.
type 
string 
Type the reference refers to (e.g. "ServiceRequest").
status 
enum [ in-progress | stopped | completed | unknown | entered-in-error ] 
A code specifying the state of the procedure.
code 
json 
Identification of the procedure.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://www.ama-assn.org/go/cpt 
  - unstructured 
code 
string 
The code of the procedure.
display 
string 
The display name of the coding.
subject 
json 
Who the procedure was performed on
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
performedDateTime 
datetime 
When the procedure was performed.   
In Canvas, this will be the datetime of service of the note the Perform command is committed to.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Procedure/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Procedure/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Procedure",
            "id": "2dd9a3bc-a3bb-472b-aaef-c57be394de39",
            "basedOn": [
                {
                    "reference": "ServiceRequest/18b3d94d-70fa-4387-817c-9b8811e52d73",
                    "type": "ServiceRequest"
                }
            ],
            "status": "unknown",
            "code": {
                "coding": [
                    {
                        "system": "http://www.ama-assn.org/go/cpt",
                        "code": "23066",
                        "display": "Biopsy soft tissue shoulder deep"
                    }
                ]
            },
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            },
            "performedDateTime": "2023-09-20T21:18:54.263690+00:00"
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Procedure resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Procedure?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Procedure?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Procedure?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Procedure?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Procedure?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Procedure",
                        "id": "2dd9a3bc-a3bb-472b-aaef-c57be394de39",
                        "basedOn": [
                            {
                                "reference": "ServiceRequest/18b3d94d-70fa-4387-817c-9b8811e52d73",
                                "type": "ServiceRequest"
                            }
                        ],
                        "status": "unknown",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.ama-assn.org/go/cpt",
                                    "code": "23066",
                                    "display": "Biopsy soft tissue shoulder deep"
                                }
                            ]
                        },
                        "subject": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                            "type": "Patient"
                        },
                        "performedDateTime": "2023-09-20T21:18:54.263690+00:00"
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/procedure/


----- BEGIN PAGE https://docs.canvasmedical.com/api/provenance/
### 
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-provenance.html>   
In Canvas a Provenance record is created each time the following data types are created or updated in the Canvas database:
  - AllergyIntolerance
  - CarePlan
  - CareTeamMembership
  - Condition
  - ConsolidatedImmunization
  - Coverage
  - Device
  - DiagnosticReport
  - DocumentReference
  - Encounter
  - Goal
  - Observation
  - Patient
  - Prescription
  - Procedure
  - ServiceRequest
  - UpdateGoal
### Endpoints
get /Provenance/{id} get /Provenance
get
/Provenance/{id}
#### Provenance read
Read a Provenance resource.
### Path Parameters
id required
string 
The unique identifier for the Provenance   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Provenance.
target 
array[json] 
Target Reference(s)
Click to view child attributes
reference 
string 
The reference string of the target in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
**Value Options Supported:**
  - AllergyIntolerance 
  - CarePlan 
  - CareTeam 
  - Condition 
  - Coverage 
  - Device 
  - DiagnosticReport 
  - DocumentReference 
  - Encounter 
  - Goal 
  - Immunization 
  - MedicationRequest 
  - Observation 
  - Patient 
  - Procedure 
  - ServiceRequest 
display 
string 
Text alternative for the resource.
recorded 
datetime 
When the activity was recorded / updated.
location 
json 
Where the activity occurred, if relevant. Currently, this will always appear as absent data.
Click to view child attributes
extension 
array[json] 
Click to view child attributes
url 
string 
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/data-absent-reason 
valueCode 
string 
**Value Options Supported:**
  - unsupported 
activity 
json 
Activity that occurred. Canvas supports a provenance of the record being either created or updated.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-DataOperation 
code 
string 
The code of the activity.
**Value Options Supported:**
  - CREATE 
  - UPDATE 
agent 
array[json] 
Actor involved.   
The agent will be populated by the committer or originator in Canvas as the auther. If neither is found, it will default to the Canvas Organization as the composer.
Click to view child attributes
type 
json 
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/provenance-participant-type 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type 
code 
string 
The code.
**Value Options Supported:**
  - enterer 
  - performer 
  - author 
  - verifier 
  - legal 
  - attester 
  - informant 
  - custodian 
  - assembler 
  - composer 
  - transmitter 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Enterer 
  - Performer 
  - Author 
  - Verifier 
  - Legal 
  - Attester 
  - Informant 
  - Custodian 
  - Assembler 
  - Composer 
  - Transmitter 
who 
json 
Click to view child attributes
reference 
string 
The reference string of who the agent is in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`. If the reference is `Organization/00000000-0000-0000-0002-000000000000`, a committer or originator couldn't be found in Canvas as the agent, so Canvas Medical is the default agent.
type 
string 
Type the reference refers to (e.g. "Practitioner", "Organization").
display 
string 
Text alternative for the resource.
onBehalfOf 
json 
Who the agent is representing. This will always be the Canvas Medical Organization.
Click to view child attributes
reference 
string 
The reference string of who the organization is in the format of `"Organization/00000000-0000-0000-0002-000000000000"`.
type 
string 
Type the reference refers to (e.g. "Organization").
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Provenance
#### Provenance search
Search for Provenance resources.
### Query Parameters
****
_id 
string 
The identifier of the Provenance.
agent 
string 
Search by the agent of the Provenance record in the format `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"` or `Organization/00000000-0000-0000-0002-000000000000`.
patient 
string 
Search by provenance records associated to a specific patient in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
target 
string 
Search by records where the target is a specific patient or observation in the format `Patient/a39cafb9d1b445be95a2e2548e12a787` or `"Observation/920807d3-034b-4423-a65b-980068cb4bd1"`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Provenance.
target 
array[json] 
Target Reference(s)
Click to view child attributes
reference 
string 
The reference string of the target in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
**Value Options Supported:**
  - AllergyIntolerance 
  - CarePlan 
  - CareTeam 
  - Condition 
  - Coverage 
  - Device 
  - DiagnosticReport 
  - DocumentReference 
  - Encounter 
  - Goal 
  - Immunization 
  - MedicationRequest 
  - Observation 
  - Patient 
  - Procedure 
  - ServiceRequest 
display 
string 
Text alternative for the resource.
recorded 
datetime 
When the activity was recorded / updated.
location 
json 
Where the activity occurred, if relevant. Currently, this will always appear as absent data.
Click to view child attributes
extension 
array[json] 
Click to view child attributes
url 
string 
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/data-absent-reason 
valueCode 
string 
**Value Options Supported:**
  - unsupported 
activity 
json 
Activity that occurred. Canvas supports a provenance of the record being either created or updated.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-DataOperation 
code 
string 
The code of the activity.
**Value Options Supported:**
  - CREATE 
  - UPDATE 
agent 
array[json] 
Actor involved.   
The agent will be populated by the committer or originator in Canvas as the auther. If neither is found, it will default to the Canvas Organization as the composer.
Click to view child attributes
type 
json 
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/provenance-participant-type 
  - http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type 
code 
string 
The code.
**Value Options Supported:**
  - enterer 
  - performer 
  - author 
  - verifier 
  - legal 
  - attester 
  - informant 
  - custodian 
  - assembler 
  - composer 
  - transmitter 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Enterer 
  - Performer 
  - Author 
  - Verifier 
  - Legal 
  - Attester 
  - Informant 
  - Custodian 
  - Assembler 
  - Composer 
  - Transmitter 
who 
json 
Click to view child attributes
reference 
string 
The reference string of who the agent is in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`. If the reference is `Organization/00000000-0000-0000-0002-000000000000`, a committer or originator couldn't be found in Canvas as the agent, so Canvas Medical is the default agent.
type 
string 
Type the reference refers to (e.g. "Practitioner", "Organization").
display 
string 
Text alternative for the resource.
onBehalfOf 
json 
Who the agent is representing. This will always be the Canvas Medical Organization.
Click to view child attributes
reference 
string 
The reference string of who the organization is in the format of `"Organization/00000000-0000-0000-0002-000000000000"`.
type 
string 
Type the reference refers to (e.g. "Organization").
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Provenance/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Provenance/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Provenance",
            "id": "db1631ed-bcd3-4e43-84a1-7e507e8aa44c",
            "target": [
                {
                    "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                    "type": "Patient"
                }
            ],
            "recorded": "2023-09-18T14:42:14.981528+00:00",
            "activity": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-DataOperation",
                        "code": "CREATE"
                    }
                ]
            },
            "agent": [
                {
                    "type": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                "code": "composer",
                                "display": "Composer"
                            }
                        ]
                    },
                    "who": {
                        "reference": "Organization/00000000-0000-0000-0002-000000000000",
                        "type": "Organization",
                        "display": "Canvas Medical"
                    },
                    "onBehalfOf": {
                        "reference": "Organization/00000000-0000-0000-0002-000000000000",
                        "type": "Organization"
                    }
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Provenance resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Provenance?target=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Provenance?target=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Provenance?target=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Provenance?target=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Provenance?target=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Provenance",
                        "id": "db1631ed-bcd3-4e43-84a1-7e507e8aa44c",
                        "target": [
                            {
                                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                                "type": "Patient"
                            }
                        ],
                        "recorded": "2023-09-18T14:42:14.981528+00:00",
                        "activity": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-DataOperation",
                                    "code": "CREATE"
                                }
                            ]
                        },
                        "agent": [
                            {
                                "type": {
                                    "coding": [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                            "code": "composer",
                                            "display": "Composer"
                                        }
                                    ]
                                },
                                "who": {
                                    "reference": "Organization/00000000-0000-0000-0002-000000000000",
                                    "type": "Organization",
                                    "display": "Canvas Medical"
                                },
                                "onBehalfOf": {
                                    "reference": "Organization/00000000-0000-0000-0002-000000000000",
                                    "type": "Organization"
                                }
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/provenance/


----- BEGIN PAGE https://docs.canvasmedical.com/api/questionnaire/
### 
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.  
<https://hl7.org/fhir/R4/questionnaire.html>  
See our [article](https://canvas-medical.help.usepylon.com/articles/7017593857-creating-questionnaires) for information about how to create and upload a questionnaire in Canvas.  
**Understanding Canvas Questionnaires**  
_Codings_  
All questionnaires must have coding, and all response options within a question on a questionnaire must have codings.  
_Question Types_  
Canvas supports 4 different type of questions:  
1\. Multi select response questions are denoted with:  
`"type": "choice", "repeats": true`  
2\. Single select response questions are denoted with:  
`"type": "choice", "repeats": false`  
3\. Free text response questions are denoted with:  
`"type": "text", "repeats": false`  
4\. Date response questions are denoted with:  
`"type": "date", "repeats": false`  
Questions can be reused in multiple questionnaires, but any given question code should only appear once within a particular questionnaire.
### Endpoints
get /Questionnaire/{id} get /Questionnaire
get
/Questionnaire/{id}
#### Questionnaire read
Read an Questionnaire resource.
### Path Parameters
id required
string 
The unique identifier for the Questionnaire   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Questionnaire.
name 
string 
Name for this questionnaire (computer friendly).  
Canvas automatically versions questionnaires based on the name. Once a questionnaire is retired, you will see a version number next to the name (e.g `PHQ-9 (v7)`)
status 
enum [ active | retired ] 
The status of this questionnaire. Enables tracking the life-cycle of the content.
description 
string 
Natural language description of the questionnaire. May contain markdown syntax.
code 
array[json] 
Concept that represents the overall questionnaire.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the questionnaire.
item 
array[json] 
Questions and sections within the Questionnaire.
Click to view child attributes
linkId 
string 
Unique id for item in questionnaire.
code 
array[json] 
Corresponding concept for this item in a terminology.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the question.
text 
string 
Primary text for the item.
type 
string 
The type of questionnaire item this is.
**Value Options Supported:**
  - group (for nested groups of items) 
  - choice (for multiple or single choice questions) 
  - text (for free text questions) 
  - decimal (for decimal numeric questions) 
  - date (for date questions) 
repeats 
boolean 
Whether the item may repeat. This value will be true for multiple choice questions and false for single select questions.
enableWhen 
array[json] 
Conditions under which this question is enabled (displayed). Corresponds to FHIR `enableWhen`.
Click to view child attributes
question 
string 
The linkId of the question whose answer is evaluated.
operator 
string 
The comparison operator.
**Value Options Supported:**
  - = 
  - != 
  - exists 
  - not_exists 
answerCoding 
json 
Value for comparison when the condition references a choice question.
Click to view child attributes
code 
string 
The code of the answer option to match.
display 
string 
The display name of the answer option.
answerString 
string 
Value for comparison when the condition references a free text question.
answerBoolean 
boolean 
Used with the `exists` operator to indicate whether the referenced question must be answered (`true`) or unanswered (`false`).
enableBehavior 
string 
Controls whether `all` or `any` of the `enableWhen` conditions must be met. Only present when there are multiple `enableWhen` conditions.
**Value Options Supported:**
  - all 
  - any 
answerOption 
array[json] 
Permitted answers
Click to view child attributes
valueCoding 
json 
Answer value.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the answer.
display 
string 
The display name of the coding.
item 
array[json] 
Nested questionnaire items. A nested `item` attribute can represent questions nested under other questions, or groups of nested items. The attributes for nested items are the same as the attributes for items at the root level.  
If `item` is nested under an `item` of type **group** , then it represents a member of a group. If `item` is nested under an `item` of any type other than **group** or **display** , then it represents an item nested under a question.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Questionnaire
#### Questionnaire search
Search for Questionnaire resources.
### Query Parameters
****
_id 
string 
The identifier of the Questionnaire.
code 
string 
A code that corresponds to one of its items in the questionnaire.  
A Questionnaire search of the form `/Questionnaire?code=456789` will return Questionnaire resources uploaded to Canvas that have a question with the code **456789**.
name 
string 
Computationally friendly name of the questionnaire
questionnaire-code 
string 
A code that matches the Questionnaire's own `code` value.  
A Questionnaire search of the form `/Questionnaire?questionnaire-code=711013002` will return Questionnaire resources uploaded to Canvas that have the code **711013002**.
status 
string 
The current status of the questionnaire  
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the Questionnaire.
name 
string 
Name for this questionnaire (computer friendly).  
Canvas automatically versions questionnaires based on the name. Once a questionnaire is retired, you will see a version number next to the name (e.g `PHQ-9 (v7)`)
status 
enum [ active | retired ] 
The status of this questionnaire. Enables tracking the life-cycle of the content.
description 
string 
Natural language description of the questionnaire. May contain markdown syntax.
code 
array[json] 
Concept that represents the overall questionnaire.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the questionnaire.
item 
array[json] 
Questions and sections within the Questionnaire.
Click to view child attributes
linkId 
string 
Unique id for item in questionnaire.
code 
array[json] 
Corresponding concept for this item in a terminology.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the question.
text 
string 
Primary text for the item.
type 
string 
The type of questionnaire item this is.
**Value Options Supported:**
  - group (for nested groups of items) 
  - choice (for multiple or single choice questions) 
  - text (for free text questions) 
  - decimal (for decimal numeric questions) 
  - date (for date questions) 
repeats 
boolean 
Whether the item may repeat. This value will be true for multiple choice questions and false for single select questions.
enableWhen 
array[json] 
Conditions under which this question is enabled (displayed). Corresponds to FHIR `enableWhen`.
Click to view child attributes
question 
string 
The linkId of the question whose answer is evaluated.
operator 
string 
The comparison operator.
**Value Options Supported:**
  - = 
  - != 
  - exists 
  - not_exists 
answerCoding 
json 
Value for comparison when the condition references a choice question.
Click to view child attributes
code 
string 
The code of the answer option to match.
display 
string 
The display name of the answer option.
answerString 
string 
Value for comparison when the condition references a free text question.
answerBoolean 
boolean 
Used with the `exists` operator to indicate whether the referenced question must be answered (`true`) or unanswered (`false`).
enableBehavior 
string 
Controls whether `all` or `any` of the `enableWhen` conditions must be met. Only present when there are multiple `enableWhen` conditions.
**Value Options Supported:**
  - all 
  - any 
answerOption 
array[json] 
Permitted answers
Click to view child attributes
valueCoding 
json 
Answer value.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the answer.
display 
string 
The display name of the coding.
item 
array[json] 
Nested questionnaire items. A nested `item` attribute can represent questions nested under other questions, or groups of nested items. The attributes for nested items are the same as the attributes for items at the root level.  
If `item` is nested under an `item` of type **group** , then it represents a member of a group. If `item` is nested under an `item` of any type other than **group** or **display** , then it represents an item nested under a question.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Questionnaire/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Questionnaire/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Questionnaire",
            "id": "47a408d7-9f1d-4cfd-97c7-aa810df9ed39",
            "name": "Exercise",
            "status": "active",
            "description": "No Description Provided",
            "code": [
                {
                    "system": "http://snomed.info/sct",
                    "code": "404684003"
                }
            ],
            "item": [
                {
                    "linkId": "d82e29db-0cac-4b97-a5aa-9e81749686e2",
                    "code": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "228448000"
                        }
                    ],
                    "text": "Do you exercise on a regular basis?",
                    "type": "choice",
                    "repeats": false,
                    "answerOption": [
                        {
                            "valueCoding": {
                                "system": "http://loinc.org",
                                "code": "LA33-6",
                                "display": "Yes"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://loinc.org",
                                "code": "LA32-8",
                                "display": "No"
                            }
                        }
                    ]
                },
                {
                    "linkId": "f2419de1-a208-4a3f-9d55-ba9bd5ed4ec2",
                    "code": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "228449008"
                        }
                    ],
                    "text": "In an average week, how many days do you exercise?",
                    "type": "choice",
                    "enableWhen": [
                        {
                            "question": "d82e29db-0cac-4b97-a5aa-9e81749686e2",
                            "operator": "=",
                            "answerCoding": {
                                "code": "LA33-6",
                                "display": "Yes"
                            }
                        }
                    ],
                    "repeats": false,
                    "answerOption": [
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A1",
                                "display": "0"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A2",
                                "display": "1"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A3",
                                "display": "2"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A4",
                                "display": "3"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A5",
                                "display": "4"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A6",
                                "display": "5"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A7",
                                "display": "6"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q2_A8",
                                "display": "7"
                            }
                        }
                    ]
                },
                {
                    "linkId": "93137723-295f-4b28-9f97-fb58825b2cda",
                    "code": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "255257008"
                        }
                    ],
                    "text": "On the days when you exercised, for how long did you exercise?",
                    "type": "choice",
                    "enableWhen": [
                        {
                            "question": "d82e29db-0cac-4b97-a5aa-9e81749686e2",
                            "operator": "=",
                            "answerCoding": {
                                "code": "LA33-6",
                                "display": "Yes"
                            }
                        },
                        {
                            "question": "f2419de1-a208-4a3f-9d55-ba9bd5ed4ec2",
                            "operator": "exists",
                            "answerBoolean": true
                        }
                    ],
                    "enableBehavior": "all",
                    "repeats": false,
                    "answerOption": [
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q3_A1",
                                "display": "10-20 min"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q3_A2",
                                "display": "20-40 min"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q3_A3",
                                "display": "40-60 min"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q3_A4",
                                "display": "> 1 hr"
                            }
                        }
                    ]
                },
                {
                    "linkId": "7eb053cd-cb2d-435f-8f55-f154645b55c4",
                    "code": [
                        {
                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                            "code": "QUES_EXERCISE_Q4"
                        }
                    ],
                    "text": "What type of exercise do you do?",
                    "type": "text",
                    "enableWhen": [
                        {
                            "question": "93137723-295f-4b28-9f97-fb58825b2cda",
                            "operator": "=",
                            "answerCoding": {
                                "code": "QUES_EXERCISE_Q3_A3",
                                "display": "40-60 min"
                            }
                        }
                    ],
                    "repeats": false,
                    "answerOption": [
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q4_A1",
                                "display": "TXT"
                            }
                        }
                    ]
                },
                {
                    "linkId": "c47a9e05-2b8d-4f31-9a6e-1d5b3c8f7e20",
                    "code": [
                        {
                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                            "code": "QUES_EXERCISE_Q5"
                        }
                    ],
                    "text": "When did you last exercise?",
                    "type": "date",
                    "repeats": false,
                    "answerOption": [
                        {
                            "valueCoding": {
                                "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                "code": "QUES_EXERCISE_Q5_A1",
                                "display": "DATE"
                            }
                        }
                    ]
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Questionnaire resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Questionnaire?name=exercise' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Questionnaire?name=exercise"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/Questionnaire?name=exercise&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Questionnaire?name=exercise&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Questionnaire?name=exercise&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "Questionnaire",
                        "id": "47a408d7-9f1d-4cfd-97c7-aa810df9ed39",
                        "name": "Exercise",
                        "status": "active",
                        "description": "No Description Provided",
                        "code": [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "404684003"
                            }
                        ],
                        "item": [
                            {
                                "linkId": "d82e29db-0cac-4b97-a5aa-9e81749686e2",
                                "code": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "228448000"
                                    }
                                ],
                                "text": "Do you exercise on a regular basis?",
                                "type": "choice",
                                "repeats": false,
                                "answerOption": [
                                    {
                                        "valueCoding": {
                                            "system": "http://loinc.org",
                                            "code": "LA33-6",
                                            "display": "Yes"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://loinc.org",
                                            "code": "LA32-8",
                                            "display": "No"
                                        }
                                    }
                                ]
                            },
                            {
                                "linkId": "f2419de1-a208-4a3f-9d55-ba9bd5ed4ec2",
                                "code": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "228449008"
                                    }
                                ],
                                "text": "In an average week, how many days do you exercise?",
                                "type": "choice",
                                "enableWhen": [
                                    {
                                        "question": "d82e29db-0cac-4b97-a5aa-9e81749686e2",
                                        "operator": "=",
                                        "answerCoding": {
                                            "code": "LA33-6",
                                            "display": "Yes"
                                        }
                                    }
                                ],
                                "repeats": false,
                                "answerOption": [
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A1",
                                            "display": "0"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A2",
                                            "display": "1"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A3",
                                            "display": "2"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A4",
                                            "display": "3"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A5",
                                            "display": "4"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A6",
                                            "display": "5"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A7",
                                            "display": "6"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q2_A8",
                                            "display": "7"
                                        }
                                    }
                                ]
                            },
                            {
                                "linkId": "93137723-295f-4b28-9f97-fb58825b2cda",
                                "code": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "255257008"
                                    }
                                ],
                                "text": "On the days when you exercised, for how long did you exercise?",
                                "type": "choice",
                                "enableWhen": [
                                    {
                                        "question": "d82e29db-0cac-4b97-a5aa-9e81749686e2",
                                        "operator": "=",
                                        "answerCoding": {
                                            "code": "LA33-6",
                                            "display": "Yes"
                                        }
                                    },
                                    {
                                        "question": "f2419de1-a208-4a3f-9d55-ba9bd5ed4ec2",
                                        "operator": "exists",
                                        "answerBoolean": true
                                    }
                                ],
                                "enableBehavior": "all",
                                "repeats": false,
                                "answerOption": [
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q3_A1",
                                            "display": "10-20 min"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q3_A2",
                                            "display": "20-40 min"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q3_A3",
                                            "display": "40-60 min"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q3_A4",
                                            "display": "> 1 hr"
                                        }
                                    }
                                ]
                            },
                            {
                                "linkId": "7eb053cd-cb2d-435f-8f55-f154645b55c4",
                                "code": [
                                    {
                                        "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                        "code": "QUES_EXERCISE_Q4"
                                    }
                                ],
                                "text": "What type of exercise do you do?",
                                "type": "text",
                                "enableWhen": [
                                    {
                                        "question": "93137723-295f-4b28-9f97-fb58825b2cda",
                                        "operator": "=",
                                        "answerCoding": {
                                            "code": "QUES_EXERCISE_Q3_A3",
                                            "display": "40-60 min"
                                        }
                                    }
                                ],
                                "repeats": false,
                                "answerOption": [
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q4_A1",
                                            "display": "TXT"
                                        }
                                    }
                                ]
                            },
                            {
                                "linkId": "c47a9e05-2b8d-4f31-9a6e-1d5b3c8f7e20",
                                "code": [
                                    {
                                        "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                        "code": "QUES_EXERCISE_Q5"
                                    }
                                ],
                                "text": "When did you last exercise?",
                                "type": "date",
                                "repeats": false,
                                "answerOption": [
                                    {
                                        "valueCoding": {
                                            "system": "http://schemas.example.canvasmedical.com/fhir/systems/internal",
                                            "code": "QUES_EXERCISE_Q5_A1",
                                            "display": "DATE"
                                        }
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/questionnaire/


----- BEGIN PAGE https://docs.canvasmedical.com/api/questionnaireresponse/
### 
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-questionnaireresponse.html>  
See this [article](https://help.canvasmedical.com/articles/7017593857-creating-questionnaires) for information about how to build questionnaires in Canvas.  
Questionnaires can map to four different commands in the Canvas UI depending on what the use case in charting is set to:
  - [Questionnaire](https://canvas-medical.help.usepylon.com/articles/5651999344-command-questionnaire)
  - [Structured Assessment](https://canvas-medical.help.usepylon.com/articles/8805008571-command-structured-assessment)
  - [Review of Systems](https://canvas-medical.help.usepylon.com/articles/9046024531-command-review-of-systems)
  - [Physical Exam](https://canvas-medical.help.usepylon.com/articles/1745103290-command-physical-exam)
QuestionnaireResponse resources contain answers to questions in a Questionnaire resource. Use the [Questionnaire search endpoint](/api/questionnaire/#search) to find Questionnaire resources.
### Endpoints
post /QuestionnaireResponse get /QuestionnaireResponse/{id} put /QuestionnaireResponse/{id} get /QuestionnaireResponse
post
/QuestionnaireResponse
#### QuestionnaireResponse create
Create an QuestionnaireResponse resource.
### Attributes
resourceType 
string 
The FHIR Resource name.
extension 
array[json] 
Additional content defined by implementations  
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).  
**Important:** For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.  
Click to view child attributes
url 
string required
Reference that defines the content of this object.
**Value Options Supported:**
  - For note identifier we have a url of `http://schemas.canvasmedical.com/fhir/extensions/note-id` 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier
questionnaire 
string 
Form being answered.  
The `questionnaire` field contains an absolute URL to a Questionnaire, e.g. `https://fumage-example.canvasmedical.com/Questionnaire/ac1da1a4-ccc4-492e-a9e0-7f70a58c2129`. Questionnaire IDs can be obtained using the [Questionnaire search endpoint](/api/questionnaire/#search). Either the `questionnaire` attribute or the URL extension under `_questionnaire` must be provided.
_questionnaire 
json 
This attribute contains the extensions for the `questionnaire` attribute.
Click to view child attributes
extension 
array[json] 
Extensions on the `questionnaire` attribute. Supported extensions include questionnaire name and URL.
To create a QuestionnaireResponse that responds to a non-FHIR questionnaire, like an external PDF file, the URL extension must be provided, and the `questionnaire` attribute must be omitted. In this scenario, there is no `Questionnaire` resource referenced by the `questionnaire` attribute. Question text must be provided for each `item`, and only `valueString` answers are permitted.  
When a QuestionnaireResponse is created in this manner, it does **not** result in the insertion of a command into a note.
Click to view child attributes
url 
string 
Source of the definition of the extension code.
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/display 
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri 
valueString 
string 
Display name for the Questionnaire referenced by `questionnaire`
valueUri 
string 
The location where a non-FHIR questionnaire/survey form can be found.
status 
string required
The position of the questionnaire response within its overall lifecycle.
**Value Options Supported:**
  - completed 
subject 
json required
The subject of the questions.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
encounter 
json 
Encounter created as part of.  
If `encounter` is provided, the QuestionnaireResponse will be added to the existing encounter (note). If it is not provided, a new data import note will be created. It will be inserted into the timeline using the timestamp passed in `authored`.  
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string required
The reference string of the encounter in the format of `"Encounter/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Encounter")
authored 
datetime 
Note datetime of service where the answers are associated with in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.  
If omitted, the current timestamp will be used.
author 
json 
Person who received and recorded the answers.  
If omitted, then the built-in automation user **Canvas Bot** will be set as the author.  
Supported reference types for create operations are: **Patient** , **Practitioner**
Click to view child attributes
reference 
string required
The reference string of the author in the format of `"Practitioner/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner")
item 
array[json] 
Groups and questions  
The `item` attribute contains the answers to the questions in the Questionnaire. The `item` attribute in QuestionnaireResponse corresponds to the `item` attribute in Questionnaire payload, and are related via the `linkId` attribute. If a question's answer is omitted, it will be left unanswered in Canvas. However, if it is a questionnaire tied to a scoring function, Canvas requires all questions to be answered in order to accurately score the Questionnaire.  
Each `item` must contain a `linkId` and `answer` attributes. The `answer` attribute is a list of answers for the question referred to by the `linkId`.  
Canvas supports the following question formats:  
• Free text  
• Single choice  
• Multiple choice  
• Date  
Answers to free text questions are provided as a `valueString`. Answers to decimal questions are provided as a `valueDecimal`. Answers to single and multiple choice questions are provided as a `valueCoding`. Answers to date questions are provided as a `valueDate`, an ISO 8601 calendar date (`YYYY-MM-DD`). See the request and response examples for more information.  
The following mappings show how the FHIR system URI is mapped to the Canvas system (FHIR -> Canvas):  
FHIR system uri | Canvas system value  
---|---  
http://loinc.org | LOINC  
http://snomed.info/sct | SNOMED  
http://canvasmedical.com | CANVAS  
http://www.ama-assn.org/go/cpt | CPT  
http://hl7.org/fhir/sid/icd-10 | ICD-10  
http://schemas.{instance-name}.canvasmedical.com/fhir/systems/internal | INTERNAL  
Click to view child attributes
linkId 
string required
A Canvas assigned identifier that uniquely identifies this question in Canvas. This linkId must only occur at most once in the payload. You can retrieve this from FHIR Questionnaire Search/Read
text 
string 
Human readable text of the question. This value is not stored for QuestionnaireResponse resources that respond to FHIR questionnaires (i.e. QuestionnaireResponse resources that have a value for `questionnaire`), but it is stored for (and is required by) QuestionnaireResponse resources that respond to questionnaires that are not represented by a FHIR resource, such as a PDF containing a set of questions. Required for QuestionnaireResponses that target an external questionnaire URL.
answer 
array[json] required
A list of one or more answers to this question.
Click to view child attributes
valueString 
string 
For question where the answer is a free-text field (i.e. Questionnaire item type = "text"), then the list will contain a single object containing a valueString field with the response text.
valueDecimal 
decimal 
For question where the answer is a decimal (i.e. Questionnaire item type = "decimal"), then the list will contain a single object containing a valueDecimal field with the response value.
valueDate 
date 
For a question where the answer is a date (i.e. Questionnaire item type = "date"), then the list will contain a single object containing a valueDate field with the response date, as an ISO 8601 calendar date (YYYY-MM-DD).
valueCoding 
json 
For a question where the answer is a single or multiple choice selection (i.e. Questionnaire item `type` = "choice" and `repeats` is "false" for single or "true" for multiple), then the list will have one or more ValueCoding objects. You can retrieve these coding options in the Questionnaire Read/Search endpoint.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string required
The code of the answer.
display 
string required
The display name of the coding.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
**Validation Errors**  
_Beware of ambiguous choices!_  
If the questionnaire contains a question with identical codings for different choices, Canvas will not know which of the choices were selected. In this case, Canvas will reject the request. For the request to succeed, each question must have a uniquely coded set of choices. Choice codings can be reused across questions, but not within them.If this scenario occurs, you will get the error message: `Question received a response option code: {code} that belongs to more than one option response`  
_More Coding Validation_  
The system is the `valueCoding` answer needs to match the system that the question specified in the Questionnaire Search Response. If it does not, you will get the error: `Question expects answer of code system {system} but {system} was given`  
If a code is passed that does not exist for that question in Canvas, you will get the error: `Question received an invalid response option code: {code}`  
_Answer Validation_  
For single or free text questions, if more than one answer is provided, you will get the error: `Question of type {type} is expecting at most one answer`  
For free text questions, the answer object must include a `valueString` or you will get the error: `Question of type TXT expects a valueString answer`  
For single or multiple choice questions, the answer objects must include a `valueCoding` or you will see one of these errors:  
`Question of type SING expects a valueCoding answer`  
`Question of type MULT expects a valueCoding answer`  
For date questions, the answer object must include a `valueDate` or you will get the error: `Question of type DATE expects a valueDate answer`
get
/QuestionnaireResponse/{id}
#### QuestionnaireResponse read
Read an QuestionnaireResponse resource.
### Path Parameters
id required
string 
The unique identifier for the QuestionnaireResponse   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the QuestionnaireResponse.
extension 
array[json] 
Additional content defined by implementations  
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).  
**Important:** For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.  
The Questionnaire permalink is included in the `extension` attribute. This will take you directly to the command in the patient's chart.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - For permalinks which have a url of `http://schemas.canvasmedical.com/fhir/extensions/questionnaire-permalink` 
  - For note identifier we have a url of `http://schemas.canvasmedical.com/fhir/extensions/note-id` 
valueString 
string 
The permalink extension will have a `valueString` returned that represents a url. This url will take you to the exact command in the Canvas UI the response is captured. It will look like `https://<customer-identifier>.canvasmedical.com/permalinks/v1/SW50ZXJ2aWV3OjUxOjc1NTU=`
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier
identifier 
json 
Unique id for this set of answers
Click to view child attributes
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/questionnaireresponse-identifier 
value 
string 
The identifier value that is unique.
questionnaire 
string 
Form being answered.  
The `questionnaire` field contains an absolute URL to a Questionnaire, e.g. `https://fumage-example.canvasmedical.com/Questionnaire/ac1da1a4-ccc4-492e-a9e0-7f70a58c2129`. Questionnaire IDs can be obtained using the [Questionnaire search endpoint](/api/questionnaire/#search). Either the `questionnaire` attribute or the URL extension under `_questionnaire` must be provided.
_questionnaire 
json 
This attribute contains the extensions for the `questionnaire` attribute.
Click to view child attributes
extension 
array[json] 
Extensions on the `questionnaire` attribute. Supported extensions include questionnaire name and URL.
Click to view child attributes
url 
string 
Source of the definition of the extension code.
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/display 
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri 
valueString 
string 
Display name for the Questionnaire referenced by `questionnaire`
valueUri 
string 
The location where a non-FHIR questionnaire/survey form can be found.
status 
string 
The position of the questionnaire response within its overall lifecycle.
**Value Options Supported:**
  - completed 
  - entered-in-error 
  - in-progress 
subject 
json 
The subject of the questions.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
encounter 
json 
Encounter created as part of.  
If `encounter` is provided, the QuestionnaireResponse will be added to the existing encounter (note). If it is not provided, a new data import note will be created. It will be inserted into the timeline using the timestamp passed in `authored`.  
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Encounter")
authored 
datetime 
Note datetime of service where the answers are associated with in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.  
author 
json 
Person who received and recorded the answers.  
If omitted, then the built-in automation user **Canvas Bot** will be set as the author.  
Supported reference types for create operations are: **Patient** , **Practitioner**
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner")
item 
array[json] 
Groups and questions  
The `item` attribute contains the answers to the questions in the Questionnaire. The `item` attribute in QuestionnaireResponse corresponds to the `item` attribute in Questionnaire payload, and are related via the `linkId` attribute. If a question's answer is omitted, it will be left unanswered in Canvas. However, if it is a questionnaire tied to a scoring function, Canvas requires all questions to be answered in order to accurately score the Questionnaire.  
Each `item` must contain a `linkId` and `answer` attributes. The `answer` attribute is a list of answers for the question referred to by the `linkId`.  
Canvas supports the following question formats:  
• Free text  
• Single choice  
• Multiple choice  
• Date  
Answers to free text questions are provided as a `valueString`. Answers to decimal questions are provided as a `valueDecimal`. Answers to single and multiple choice questions are provided as a `valueCoding`. Answers to date questions are provided as a `valueDate`, an ISO 8601 calendar date (`YYYY-MM-DD`). See the request and response examples for more information.  
The following mappings show how the FHIR system URI is mapped to the Canvas system (FHIR -> Canvas):  
FHIR system uri | Canvas system value  
---|---  
http://loinc.org | LOINC  
http://snomed.info/sct | SNOMED  
http://canvasmedical.com | CANVAS  
http://www.ama-assn.org/go/cpt | CPT  
http://hl7.org/fhir/sid/icd-10 | ICD-10  
http://schemas.{instance-name}.canvasmedical.com/fhir/systems/internal | INTERNAL  
Click to view child attributes
linkId 
string 
A Canvas assigned identifier that uniquely identifies this question in Canvas. This linkId must only occur at most once in the payload. You can retrieve this from FHIR Questionnaire Search/Read
text 
string 
Human readable text of the question. This value is not stored for QuestionnaireResponse resources that respond to FHIR questionnaires (i.e. QuestionnaireResponse resources that have a value for `questionnaire`), but it is stored for (and is required by) QuestionnaireResponse resources that respond to questionnaires that are not represented by a FHIR resource, such as a PDF containing a set of questions. Required for QuestionnaireResponses that target an external questionnaire URL.
answer 
array[json] 
A list of one or more answers to this question.
Click to view child attributes
valueString 
string 
For question where the answer is a free-text field (i.e. Questionnaire item type = "text"), then the list will contain a single object containing a valueString field with the response text.
valueDecimal 
decimal 
For question where the answer is a decimal (i.e. Questionnaire item type = "decimal"), then the list will contain a single object containing a valueDecimal field with the response value.
valueDate 
date 
For a question where the answer is a date (i.e. Questionnaire item type = "date"), then the list will contain a single object containing a valueDate field with the response date, as an ISO 8601 calendar date (YYYY-MM-DD).
valueCoding 
json 
For a question where the answer is a single or multiple choice selection (i.e. Questionnaire item `type` = "choice" and `repeats` is "false" for single or "true" for multiple), then the list will have one or more ValueCoding objects. You can retrieve these coding options in the Questionnaire Read/Search endpoint.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the answer.
display 
string 
The display name of the coding.
item 
array[json] 
Nested questionnaire response items. This `item` attribute is nested underneath an `answer`, which means it contains response items to questions or groups that are nested under a question.
item 
array[json] 
Nested questionnaire response items. This `item` attribute is nested underneath another `item` attribute, meaning that the containing `item` represents a group. The attributes for nested items are the same as the attributes for items at the root level.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/QuestionnaireResponse/{id}
#### QuestionnaireResponse update
Update a QuestionnaireResponse resource.  
The only type of QuestionnaireResponse update interaction that is supported by Canvas is to mark an existing QuestionnaireResponse as **entered-in-error**. No changes to other fields will be processed.
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string required
The identifier of the QuestionnaireResponse.
extension 
array[json] 
Additional content defined by implementations  
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).  
**Important:** For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.  
Click to view child attributes
url 
string required
Reference that defines the content of this object.
**Value Options Supported:**
  - For note identifier we have a url of `http://schemas.canvasmedical.com/fhir/extensions/note-id` 
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier
questionnaire 
string 
Form being answered.  
The `questionnaire` field contains an absolute URL to a Questionnaire, e.g. `https://fumage-example.canvasmedical.com/Questionnaire/ac1da1a4-ccc4-492e-a9e0-7f70a58c2129`. Questionnaire IDs can be obtained using the [Questionnaire search endpoint](/api/questionnaire/#search). Either the `questionnaire` attribute or the URL extension under `_questionnaire` must be provided.
_questionnaire 
json 
This attribute contains the extensions for the `questionnaire` attribute.
Click to view child attributes
extension 
array[json] 
Extensions on the `questionnaire` attribute. Supported extensions include questionnaire name and URL.
Click to view child attributes
url 
string 
Source of the definition of the extension code.
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/display 
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri 
valueString 
string 
Display name for the Questionnaire referenced by `questionnaire`
valueUri 
string 
The location where a non-FHIR questionnaire/survey form can be found.
status 
string required
The position of the questionnaire response within its overall lifecycle.
**Value Options Supported:**
  - entered-in-error 
subject 
json required
The subject of the questions.
Click to view child attributes
reference 
string required
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
encounter 
json 
Encounter created as part of.  
If `encounter` is provided, the QuestionnaireResponse will be added to the existing encounter (note). If it is not provided, a new data import note will be created. It will be inserted into the timeline using the timestamp passed in `authored`.  
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string required
The reference string of the encounter in the format of `"Encounter/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Encounter")
authored 
datetime 
Note datetime of service where the answers are associated with in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.  
author 
json 
Person who received and recorded the answers.  
If omitted, then the built-in automation user **Canvas Bot** will be set as the author.  
Supported reference types for create operations are: **Patient** , **Practitioner**
Click to view child attributes
reference 
string required
The reference string of the author in the format of `"Practitioner/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner")
item 
array[json] 
Groups and questions  
The `item` attribute contains the answers to the questions in the Questionnaire. The `item` attribute in QuestionnaireResponse corresponds to the `item` attribute in Questionnaire payload, and are related via the `linkId` attribute. If a question's answer is omitted, it will be left unanswered in Canvas. However, if it is a questionnaire tied to a scoring function, Canvas requires all questions to be answered in order to accurately score the Questionnaire.  
Each `item` must contain a `linkId` and `answer` attributes. The `answer` attribute is a list of answers for the question referred to by the `linkId`.  
Canvas supports the following question formats:  
• Free text  
• Single choice  
• Multiple choice  
• Date  
Answers to free text questions are provided as a `valueString`. Answers to decimal questions are provided as a `valueDecimal`. Answers to single and multiple choice questions are provided as a `valueCoding`. Answers to date questions are provided as a `valueDate`, an ISO 8601 calendar date (`YYYY-MM-DD`). See the request and response examples for more information.  
The following mappings show how the FHIR system URI is mapped to the Canvas system (FHIR -> Canvas):  
FHIR system uri | Canvas system value  
---|---  
http://loinc.org | LOINC  
http://snomed.info/sct | SNOMED  
http://canvasmedical.com | CANVAS  
http://www.ama-assn.org/go/cpt | CPT  
http://hl7.org/fhir/sid/icd-10 | ICD-10  
http://schemas.{instance-name}.canvasmedical.com/fhir/systems/internal | INTERNAL  
Click to view child attributes
linkId 
string required
A Canvas assigned identifier that uniquely identifies this question in Canvas. This linkId must only occur at most once in the payload. You can retrieve this from FHIR Questionnaire Search/Read
text 
string 
Human readable text of the question. This value is not stored for QuestionnaireResponse resources that respond to FHIR questionnaires (i.e. QuestionnaireResponse resources that have a value for `questionnaire`), but it is stored for (and is required by) QuestionnaireResponse resources that respond to questionnaires that are not represented by a FHIR resource, such as a PDF containing a set of questions. Required for QuestionnaireResponses that target an external questionnaire URL.
answer 
array[json] required
A list of one or more answers to this question.
Click to view child attributes
valueString 
string 
For question where the answer is a free-text field (i.e. Questionnaire item type = "text"), then the list will contain a single object containing a valueString field with the response text.
valueDecimal 
decimal 
For question where the answer is a decimal (i.e. Questionnaire item type = "decimal"), then the list will contain a single object containing a valueDecimal field with the response value.
valueDate 
date 
For a question where the answer is a date (i.e. Questionnaire item type = "date"), then the list will contain a single object containing a valueDate field with the response date, as an ISO 8601 calendar date (YYYY-MM-DD).
valueCoding 
json 
For a question where the answer is a single or multiple choice selection (i.e. Questionnaire item `type` = "choice" and `repeats` is "false" for single or "true" for multiple), then the list will have one or more ValueCoding objects. You can retrieve these coding options in the Questionnaire Read/Search endpoint.
Click to view child attributes
system 
string required
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string required
The code of the answer.
display 
string required
The display name of the coding.
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/QuestionnaireResponse
#### QuestionnaireResponse search
Search for QuestionnaireResponse resources.
### Query Parameters
****
_id 
string 
The identifier of the QuestionnaireResponse.
authored 
datetime 
Filter by the `authored` attribute. See [Date Filtering](/api/date-filtering) for more information.
patient 
string 
The patient that is the subject of the questionnaire response in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
questionnaire 
string 
The questionnaire the answers are provided for in the format "https://fumage-example.canvasmedical.com/Questionnaire/7eefd6fc-0000-44c2-8224-d95f0ceaa2fd".
questionnaire.code 
string 
Filters by the code and/or system of the associated questionnaire. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g `http://snomed.info/sct|404684003`).
questionnaire.item.code 
string 
Filters by the code and/or system of questions in the questionnaire. You can search by just the code value or you can search by the system and code in the format `system|code` (e.g `http://snomed.info/sct|404684003`).
_sort 
string 
Triggers sorting of the results by a specific criteria. The results will be in ascending order unless you add a `-` in front to sort in descending order.
**Search Values Supported:**
  - _id
  - authored
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the QuestionnaireResponse.
extension 
array[json] 
Additional content defined by implementations  
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the [Canvas Note API](/api/note).  
**Important:** For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.  
The Questionnaire permalink is included in the `extension` attribute. This will take you directly to the command in the patient's chart.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - For permalinks which have a url of `http://schemas.canvasmedical.com/fhir/extensions/questionnaire-permalink` 
  - For note identifier we have a url of `http://schemas.canvasmedical.com/fhir/extensions/note-id` 
valueString 
string 
The permalink extension will have a `valueString` returned that represents a url. This url will take you to the exact command in the Canvas UI the response is captured. It will look like `https://<customer-identifier>.canvasmedical.com/permalinks/v1/SW50ZXJ2aWV3OjUxOjc1NTU=`
valueId 
string 
The valueId field is used for the Note extension and will be the note's unique identifier
identifier 
json 
Unique id for this set of answers
Click to view child attributes
system 
string 
The namespace for the identifier value.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/questionnaireresponse-identifier 
value 
string 
The identifier value that is unique.
questionnaire 
string 
Form being answered.  
The `questionnaire` field contains an absolute URL to a Questionnaire, e.g. `https://fumage-example.canvasmedical.com/Questionnaire/ac1da1a4-ccc4-492e-a9e0-7f70a58c2129`. Questionnaire IDs can be obtained using the [Questionnaire search endpoint](/api/questionnaire/#search). Either the `questionnaire` attribute or the URL extension under `_questionnaire` must be provided.
_questionnaire 
json 
This attribute contains the extensions for the `questionnaire` attribute.
Click to view child attributes
extension 
array[json] 
Extensions on the `questionnaire` attribute. Supported extensions include questionnaire name and URL.
Click to view child attributes
url 
string 
Source of the definition of the extension code.
**Value Options Supported:**
  - http://hl7.org/fhir/StructureDefinition/display 
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri 
valueString 
string 
Display name for the Questionnaire referenced by `questionnaire`
valueUri 
string 
The location where a non-FHIR questionnaire/survey form can be found.
status 
string 
The position of the questionnaire response within its overall lifecycle.
**Value Options Supported:**
  - completed 
  - entered-in-error 
  - in-progress 
subject 
json 
The subject of the questions.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`
type 
string 
Type the reference refers to (e.g. "Patient")
encounter 
json 
Encounter created as part of.  
If `encounter` is provided, the QuestionnaireResponse will be added to the existing encounter (note). If it is not provided, a new data import note will be created. It will be inserted into the timeline using the timestamp passed in `authored`.  
**Canvas does not currently support concurrent creation of resources on the same encounter.** Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
Click to view child attributes
reference 
string 
The reference string of the encounter in the format of `"Encounter/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Encounter")
authored 
datetime 
Note datetime of service where the answers are associated with in ISO 8601 format like `"2022-03-19T14:54:12.194952+00:00"`.  
author 
json 
Person who received and recorded the answers.  
If omitted, then the built-in automation user **Canvas Bot** will be set as the author.  
Supported reference types for create operations are: **Patient** , **Practitioner**
Click to view child attributes
reference 
string 
The reference string of the author in the format of `"Practitioner/cdbd6534-ba0d-4917-a5a6-6a2d46dcf0f7"`
type 
string 
Type the reference refers to (e.g. "Patient", "Practitioner")
item 
array[json] 
Groups and questions  
The `item` attribute contains the answers to the questions in the Questionnaire. The `item` attribute in QuestionnaireResponse corresponds to the `item` attribute in Questionnaire payload, and are related via the `linkId` attribute. If a question's answer is omitted, it will be left unanswered in Canvas. However, if it is a questionnaire tied to a scoring function, Canvas requires all questions to be answered in order to accurately score the Questionnaire.  
Each `item` must contain a `linkId` and `answer` attributes. The `answer` attribute is a list of answers for the question referred to by the `linkId`.  
Canvas supports the following question formats:  
• Free text  
• Single choice  
• Multiple choice  
• Date  
Answers to free text questions are provided as a `valueString`. Answers to decimal questions are provided as a `valueDecimal`. Answers to single and multiple choice questions are provided as a `valueCoding`. Answers to date questions are provided as a `valueDate`, an ISO 8601 calendar date (`YYYY-MM-DD`). See the request and response examples for more information.  
The following mappings show how the FHIR system URI is mapped to the Canvas system (FHIR -> Canvas):  
FHIR system uri | Canvas system value  
---|---  
http://loinc.org | LOINC  
http://snomed.info/sct | SNOMED  
http://canvasmedical.com | CANVAS  
http://www.ama-assn.org/go/cpt | CPT  
http://hl7.org/fhir/sid/icd-10 | ICD-10  
http://schemas.{instance-name}.canvasmedical.com/fhir/systems/internal | INTERNAL  
Click to view child attributes
linkId 
string 
A Canvas assigned identifier that uniquely identifies this question in Canvas. This linkId must only occur at most once in the payload. You can retrieve this from FHIR Questionnaire Search/Read
text 
string 
Human readable text of the question. This value is not stored for QuestionnaireResponse resources that respond to FHIR questionnaires (i.e. QuestionnaireResponse resources that have a value for `questionnaire`), but it is stored for (and is required by) QuestionnaireResponse resources that respond to questionnaires that are not represented by a FHIR resource, such as a PDF containing a set of questions. Required for QuestionnaireResponses that target an external questionnaire URL.
answer 
array[json] 
A list of one or more answers to this question.
Click to view child attributes
valueString 
string 
For question where the answer is a free-text field (i.e. Questionnaire item type = "text"), then the list will contain a single object containing a valueString field with the response text.
valueDecimal 
decimal 
For question where the answer is a decimal (i.e. Questionnaire item type = "decimal"), then the list will contain a single object containing a valueDecimal field with the response value.
valueDate 
date 
For a question where the answer is a date (i.e. Questionnaire item type = "date"), then the list will contain a single object containing a valueDate field with the response date, as an ISO 8601 calendar date (YYYY-MM-DD).
valueCoding 
json 
For a question where the answer is a single or multiple choice selection (i.e. Questionnaire item `type` = "choice" and `repeats` is "false" for single or "true" for multiple), then the list will have one or more ValueCoding objects. You can retrieve these coding options in the Questionnaire Read/Search endpoint.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://loinc.org 
  - http://snomed.info/sct 
  - http://canvasmedical.com 
  - http://www.ama-assn.org/go/cpt 
  - http://hl7.org/fhir/sid/icd-10 
  - http://schemas.{customer_identifier}.canvasmedical.com/fhir/systems/internal 
code 
string 
The code of the answer.
display 
string 
The display name of the coding.
item 
array[json] 
Nested questionnaire response items. This `item` attribute is nested underneath an `answer`, which means it contains response items to questions or groups that are nested under a question.
item 
array[json] 
Nested questionnaire response items. This `item` attribute is nested underneath another `item` attribute, meaning that the containing `item` represents a group. The attributes for nested items are the same as the attributes for items at the root level.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/QuestionnaireResponse' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "QuestionnaireResponse",
            "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "questionnaire": "https://fumage-example.canvasmedical.com/Questionnaire/7eefd6fc-0000-44c2-8224-d95f0ceaa2fd",
            "status": "completed",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/ffa0bd44-997f-4ad4-8782-1a6c0ef01f1c",
                "type": "Encounter"
            },
            "authored": "2022-12-19T18:11:20.914260+00:00",
            "author": {
                "reference": "Practitioner/9cdb7a92d6614dcfa7948f2143a9f8e8",
                "type": "Practitioner"
            },
            "item": [
                {
                    "linkId": "e2e5ddc3-a0ec-4a1b-9c53-bf2e2e990fe1",
                    "text": "Tobacco status",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "8517006",
                                "display": "Former user"
                            }
                        }
                    ]
                },
                {
                    "linkId": "d210dc3a-3427-4f58-8707-3f38393a8416",
                    "text": "Tobacco type",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722496004",
                                "display": "Cigarettes"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722498003",
                                "display": "eCigarette"
                            }
                        }
                    ]
                },
                {
                    "linkId": "a656c6c8-ecea-403f-a430-f80899f26914",
                    "text": "Tobacco comment",
                    "answer": [
                        {
                            "valueString": "Yep"
                        }
                    ]
                },
                {
                    "linkId": "b3f7c21d-5e48-4a9c-9d16-7a0c4e83f1b2",
                    "text": "If you quit smoking, what day?",
                    "answer": [
                        {
                            "valueDate": "2026-07-14"
                        }
                    ]
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/QuestionnaireResponse"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "QuestionnaireResponse",
            "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "questionnaire": "https://fumage-example.canvasmedical.com/Questionnaire/7eefd6fc-0000-44c2-8224-d95f0ceaa2fd",
            "status": "completed",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/ffa0bd44-997f-4ad4-8782-1a6c0ef01f1c",
                "type": "Encounter"
            },
            "authored": "2022-12-19T18:11:20.914260+00:00",
            "author": {
                "reference": "Practitioner/9cdb7a92d6614dcfa7948f2143a9f8e8",
                "type": "Practitioner"
            },
            "item": [
                {
                    "linkId": "e2e5ddc3-a0ec-4a1b-9c53-bf2e2e990fe1",
                    "text": "Tobacco status",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "8517006",
                                "display": "Former user"
                            }
                        }
                    ]
                },
                {
                    "linkId": "d210dc3a-3427-4f58-8707-3f38393a8416",
                    "text": "Tobacco type",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722496004",
                                "display": "Cigarettes"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722498003",
                                "display": "eCigarette"
                            }
                        }
                    ]
                },
                {
                    "linkId": "a656c6c8-ecea-403f-a430-f80899f26914",
                    "text": "Tobacco comment",
                    "answer": [
                        {
                            "valueString": "Yep"
                        }
                    ]
                },
                {
                    "linkId": "b3f7c21d-5e48-4a9c-9d16-7a0c4e83f1b2",
                    "text": "If you quit smoking, what day?",
                    "answer": [
                        {
                            "valueDate": "2026-07-14"
                        }
                    ]
                }
            ]
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/QuestionnaireResponse/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/QuestionnaireResponse/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "QuestionnaireResponse",
            "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/questionnaire-permalink",
                    "valueString": "https://example.canvasmedical.com/permalinks/v1/YWJjZGVmZ2hpamtsbW5vcHFycwo"
                }
            ],
            "questionnaire": "https://fumage-example.canvasmedical.com/Questionnaire/7eefd6fc-0000-44c2-8224-d95f0ceaa2fd",
            "status": "completed",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/ffa0bd44-997f-4ad4-8782-1a6c0ef01f1c",
                "type": "Encounter"
            },
            "authored": "2022-12-19T18:11:20.914260+00:00",
            "author": {
                "reference": "Practitioner/9cdb7a92d6614dcfa7948f2143a9f8e8",
                "type": "Practitioner"
            },
            "item": [
                {
                    "linkId": "e2e5ddc3-a0ec-4a1b-9c53-bf2e2e990fe1",
                    "text": "Tobacco status",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "8517006",
                                "display": "Former user"
                            }
                        }
                    ]
                },
                {
                    "linkId": "d210dc3a-3427-4f58-8707-3f38393a8416",
                    "text": "Tobacco type",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722496004",
                                "display": "Cigarettes"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722498003",
                                "display": "eCigarette"
                            }
                        }
                    ]
                },
                {
                    "linkId": "a656c6c8-ecea-403f-a430-f80899f26914",
                    "text": "Tobacco comment",
                    "answer": [
                        {
                            "valueString": "Yep"
                        }
                    ]
                },
                {
                    "linkId": "b3f7c21d-5e48-4a9c-9d16-7a0c4e83f1b2",
                    "text": "If you quit smoking, what day?",
                    "answer": [
                        {
                            "valueDate": "2026-07-14"
                        }
                    ]
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown QuestionnaireResponse resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/QuestionnaireResponse/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "QuestionnaireResponse",
            "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "questionnaire": "https://fumage-example.canvasmedical.com/Questionnaire/7eefd6fc-0000-44c2-8224-d95f0ceaa2fd",
            "status": "entered-in-error",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/ffa0bd44-997f-4ad4-8782-1a6c0ef01f1c",
                "type": "Encounter"
            },
            "authored": "2022-12-19T18:11:20.914260+00:00",
            "author": {
                "reference": "Practitioner/9cdb7a92d6614dcfa7948f2143a9f8e8",
                "type": "Practitioner"
            },
            "item": [
                {
                    "linkId": "e2e5ddc3-a0ec-4a1b-9c53-bf2e2e990fe1",
                    "text": "Tobacco status",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "8517006",
                                "display": "Former user"
                            }
                        }
                    ]
                },
                {
                    "linkId": "d210dc3a-3427-4f58-8707-3f38393a8416",
                    "text": "Tobacco type",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722496004",
                                "display": "Cigarettes"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722498003",
                                "display": "eCigarette"
                            }
                        }
                    ]
                },
                {
                    "linkId": "a656c6c8-ecea-403f-a430-f80899f26914",
                    "text": "Tobacco comment",
                    "answer": [
                        {
                            "valueString": "Yep"
                        }
                    ]
                },
                {
                    "linkId": "b3f7c21d-5e48-4a9c-9d16-7a0c4e83f1b2",
                    "text": "If you quit smoking, what day?",
                    "answer": [
                        {
                            "valueDate": "2026-07-14"
                        }
                    ]
                }
            ]
        }'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/QuestionnaireResponse/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        payload = {
            "resourceType": "QuestionnaireResponse",
            "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                    "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                }
            ],
            "questionnaire": "https://fumage-example.canvasmedical.com/Questionnaire/7eefd6fc-0000-44c2-8224-d95f0ceaa2fd",
            "status": "entered-in-error",
            "subject": {
                "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                "type": "Patient"
            },
            "encounter": {
                "reference": "Encounter/ffa0bd44-997f-4ad4-8782-1a6c0ef01f1c",
                "type": "Encounter"
            },
            "authored": "2022-12-19T18:11:20.914260+00:00",
            "author": {
                "reference": "Practitioner/9cdb7a92d6614dcfa7948f2143a9f8e8",
                "type": "Practitioner"
            },
            "item": [
                {
                    "linkId": "e2e5ddc3-a0ec-4a1b-9c53-bf2e2e990fe1",
                    "text": "Tobacco status",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "8517006",
                                "display": "Former user"
                            }
                        }
                    ]
                },
                {
                    "linkId": "d210dc3a-3427-4f58-8707-3f38393a8416",
                    "text": "Tobacco type",
                    "answer": [
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722496004",
                                "display": "Cigarettes"
                            }
                        },
                        {
                            "valueCoding": {
                                "system": "http://snomed.info/sct",
                                "code": "722498003",
                                "display": "eCigarette"
                            }
                        }
                    ]
                },
                {
                    "linkId": "a656c6c8-ecea-403f-a430-f80899f26914",
                    "text": "Tobacco comment",
                    "answer": [
                        {
                            "valueString": "Yep"
                        }
                    ]
                },
                {
                    "linkId": "b3f7c21d-5e48-4a9c-9d16-7a0c4e83f1b2",
                    "text": "If you quit smoking, what day?",
                    "answer": [
                        {
                            "valueDate": "2026-07-14"
                        }
                    ]
                }
            ]
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown QuestionnaireResponse resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/QuestionnaireResponse?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/QuestionnaireResponse?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link": [
                {
                    "relation": "self",
                    "url": "/QuestionnaireResponse?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/QuestionnaireResponse?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/QuestionnaireResponse?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
                }
            ],
            "entry": [
                {
                    "resource": {
                        "resourceType": "QuestionnaireResponse",
                        "id": "e76e44b4-4e68-4f72-b1c3-1de528a3bb2a",
                        "extension": [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id",
                                "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5"
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/questionnaire-permalink",
                                "valueString": "https://example.canvasmedical.com/permalinks/v1/YWJjZGVmZ2hpamtsbW5vcHFycwo"
                            }
                        ],
                        "questionnaire": "https://fumage-example.canvasmedical.com/Questionnaire/7eefd6fc-0000-44c2-8224-d95f0ceaa2fd",
                        "status": "completed",
                        "subject": {
                            "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                            "type": "Patient"
                        },
                        "encounter": {
                            "reference": "Encounter/ffa0bd44-997f-4ad4-8782-1a6c0ef01f1c",
                            "type": "Encounter"
                        },
                        "authored": "2022-12-19T18:11:20.914260+00:00",
                        "author": {
                            "reference": "Practitioner/9cdb7a92d6614dcfa7948f2143a9f8e8",
                            "type": "Practitioner"
                        },
                        "item": [
                            {
                                "linkId": "e2e5ddc3-a0ec-4a1b-9c53-bf2e2e990fe1",
                                "text": "Tobacco status",
                                "answer": [
                                    {
                                        "valueCoding": {
                                            "system": "http://snomed.info/sct",
                                            "code": "8517006",
                                            "display": "Former user"
                                        }
                                    }
                                ]
                            },
                            {
                                "linkId": "d210dc3a-3427-4f58-8707-3f38393a8416",
                                "text": "Tobacco type",
                                "answer": [
                                    {
                                        "valueCoding": {
                                            "system": "http://snomed.info/sct",
                                            "code": "722496004",
                                            "display": "Cigarettes"
                                        }
                                    },
                                    {
                                        "valueCoding": {
                                            "system": "http://snomed.info/sct",
                                            "code": "722498003",
                                            "display": "eCigarette"
                                        }
                                    }
                                ]
                            },
                            {
                                "linkId": "a656c6c8-ecea-403f-a430-f80899f26914",
                                "text": "Tobacco comment",
                                "answer": [
                                    {
                                        "valueString": "Yep"
                                    }
                                ]
                            },
                            {
                                "linkId": "b3f7c21d-5e48-4a9c-9d16-7a0c4e83f1b2",
                                "text": "If you quit smoking, what day?",
                                "answer": [
                                    {
                                        "valueDate": "2026-07-14"
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/questionnaireresponse/


----- BEGIN PAGE https://docs.canvasmedical.com/api/quickstart/
##  Authentication 
To access our FHIR API, you will need to request an access token and refresh it periodically. You can refer to our [Authentication Documentation](/api/customer-authentication) and [Authentication Best Practices](/api/authentication-best-practices) to get you set up. Access tokens expire 10 hours after they are created. You can and should reuse access tokens to reduce the number of tokens that are valid at any given time.
##  Create a patient 
Let's start by creating a patient. we've gone ahead and generated some boilerplate Patient info that includes all of the minimum required parameters for a Create a Patient request.
    ```shell
    curl -i --location 'https://fumage-<sandbox-name>.canvasmedical.com/Patient' \
         --header 'Authorization: Bearer <bearer-token>' \
         --header 'Content-Type: application/json' \
         --data '{
            "resourceType": "Patient",
            "extension": [
                {
                    "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                    "valueCode": "F"
                }
            ],
            "gender": "female",
            "active": true,
            "name": [
                {
                    "use": "official",
                    "family": "Mitko",
                    "given": [
                        "Salina"
                    ]
                }
            ],
            "birthDate": "1949-11-13"
        }'
    ```
To execute this command, first:
Replace  with your sandbox name Replace  with your Bearer token you learned about above in the Authentication Section Hit enter and your first patient, Salina Mitko, is created!
Navigate to the Canvas UI (sandbox or production instance) and log in using the credentials provided, search for Salina in the top-left search box and visit the first search result to find her chart.
For more detail about making Patient Create requests, check out the API documentation for Patient Create.
> **Info:** As part of the request's response, you will see a patient ID within the location: header. Copy the ID value between Patient/ and / history - you will need it to create an appointment in the next step.  
>   
>  Also to note that ID will match the ID you will find in your browser when you navigate to the patient's chart: https://{customer}.canvasmedical.com/patient/{patientID} 
##  Create an Appointment 
We have our first patient and now want to book their first appointment. But before we can book their appointment we will need to find a practitioner.
If you are using one of our canvas sandboxes, there will already be a demo staff member loaded in the instance.
Run the following request to find the list of Practitioners in your organization. Again you will need to replace the  and  with the same values you used to create your patient above.
    ```shell
    curl --location 'https://fumage-<sandbox-name>.canvasmedical.com/Practitioner' \
    --header 'Content-Type: application/fhir+json' \
    --header 'Authorization: Bearer <bearer-token>' | jq
    ```
You will then get a response similar to:
    ```shell
    {
      "resourceType" : "Bundle",
      "type" : "searchset",
      "total" : 1,
      "entry" : [
        {
          "resource" : {
            "resourceType" : "Practitioner",
            "id" : "e766816672f34a5b866771c773e38f3c",
            "identifier" : [
              {
                "system" : "http://hl7.org/fhir/sid/us-npi",
                "value" : "1834494258"
              }
            ],
            "name" : [
              {
                "use" : "usual",
                "text" : "Youta Priti MD",
                "family" : "Priti",
                "given" : [
                  "Youta"
                ]
              }
            ]
          }
        }
      ]
    }
    ```
Copy down the value for "id". This is the Practitioner ID you will need to create your first appointment.
Now we have our Patient ID and Practitioner ID. We're ready to create our first appointment.
Now lets set up the cURL command to create the appointment. Again you will need to replace the  and . Then replace  and  with the values copied in the last two requests. This appointment will create a Telehealth Appointment. You might want to update the start and end dates to be today's date for easy find-ability on the calendar view.
    ```shell
    curl -i --location 'https://fumage-<sandbox-name>.canvasmedical.com/Appointment' \
      --header 'Authorization: Bearer <bearer-token>' \
      --header 'Content-Type: application/json' \
      --data '{
        "resourceType": "Appointment",
        "status": "booked",
        "appointmentType": {
            "coding": [
                {
                    "system": "http://snomed.info/sct",
                    "code": "448337001",
                    "display": "Telemedicine consultation with patient (procedure)"
                }
            ]
        },
        "description": "Weekly check-in.",
        "supportingInformation" : [
          {
            "reference" : "Location/1"
          }
        ],
        "start": "2022-02-19T13:30:00.000Z",
        "end": "2022-02-19T14:00:00.000Z",
        "participant": [
            {
                "actor": {
                    "reference": "Practitioner/<practitioner-id>"
                },
                "status": "accepted"
            },
            {
                "actor": {
                    "reference": "Patient/<patient-id>"
                },
                "status": "accepted"
            }
        ]
    }'
    ```
If you navigate to the correct date you used for start and end in the request above on the Schedule of your Canvas home page, you will see your first appointment. You should also be able to see the appointment when navigating to the patient's chart.
For more detail about making Appointment Create requests, check out the API documentation for [Appointment Create](ref:create) .
----- END PAGE https://docs.canvasmedical.com/api/quickstart/


----- BEGIN PAGE https://docs.canvasmedical.com/api/relatedperson/
### 
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-relatedperson.html>
### Endpoints
get /RelatedPerson/{id} get /RelatedPerson
get
/RelatedPerson/{id}
#### RelatedPerson read
Read a RelatedPerson resource.
### Path Parameters
id required
string 
The unique identifier for the RelatedPerson   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the RelatedPerson.
active 
boolean 
Whether this related person's record is in active use.
patient 
json 
The patient this person is related to.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
relationship 
array[json] 
The nature of the relationship.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-RoleCode 
  - Empty string 
code 
string 
The code of the relationship.  
Values are nominally from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), but custom contact categories can be used as well.
display 
string 
The display name of the coding.  
Values are nominally from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), but custom contact categories can be used as well.
name 
array[json] 
A name associated with the person.
Click to view child attributes
text 
string 
Text representation of the full name.  
If the RelatedPerson is a patient contact but not a Patient on Canvas, this attribute will be populated.  
If the RelatedPerson is a Patient on Canvas, this attribute will not be populated; instead the `family`, `given`, `prefix`, and `suffix` attributes will be provided.
family 
string 
Family name (often called 'Surname').
given 
array[string] 
Given names (not always 'first'). Includes middle names.  
This repeating element order: Given Names appear in the correct order for presenting the name.
prefix 
array[string] 
Parts that come before the name.
suffix 
array[string] 
Parts that come after the name.
telecom 
array[json] 
Contact details for the individual.
Click to view child attributes
system 
string 
Supported values are **phone** , **fax** , **email** , **pager** , **url** , **sms** , and **other**.
value 
string 
Free text string of the value for this contact point.
use 
string 
Supported values are **home** , **work** , **temp** , **old** and **mobile**.
address 
array[json] 
Address where the related person can be contacted or visited
Click to view child attributes
use 
string 
Supported values are **home** , **work** , **temp** and **old**.
type 
string 
Supported values are **both** , **physical** and **postal**.
line 
array[string] 
List of strings. The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
String representing the city of the address.
district 
string 
District (e.g., county) of the address.
state 
string 
2 letter state abbreviation of the address.
postalCode 
string 
The 5 digit postal code of the address.
country 
string 
The ISO 3166 2 letter country code.
period 
json 
Click to view child attributes
start 
date 
Starting date with inclusive boundary
end 
date 
End date with inclusive boundary, if not ongoing
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/RelatedPerson
#### RelatedPerson search
Search for RelatedPerson resources.
### Query Parameters
****
_id 
string 
The identifier of the RelatedPerson.
patient 
string 
The patient reference associated with the RelatedPerson in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the RelatedPerson.
active 
boolean 
Whether this related person's record is in active use.
patient 
json 
The patient this person is related to.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Patient").
relationship 
array[json] 
The nature of the relationship.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system url of the coding.
**Value Options Supported:**
  - http://terminology.hl7.org/CodeSystem/v3-RoleCode 
  - Empty string 
code 
string 
The code of the relationship.  
Values are nominally from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), but custom contact categories can be used as well.
display 
string 
The display name of the coding.  
Values are nominally from the [PatientRelationshipType ValueSet](https://hl7.org/fhir/R4/valueset-relatedperson-relationshiptype.html), but custom contact categories can be used as well.
name 
array[json] 
A name associated with the person.
Click to view child attributes
text 
string 
Text representation of the full name.  
If the RelatedPerson is a patient contact but not a Patient on Canvas, this attribute will be populated.  
If the RelatedPerson is a Patient on Canvas, this attribute will not be populated; instead the `family`, `given`, `prefix`, and `suffix` attributes will be provided.
family 
string 
Family name (often called 'Surname').
given 
array[string] 
Given names (not always 'first'). Includes middle names.  
This repeating element order: Given Names appear in the correct order for presenting the name.
prefix 
array[string] 
Parts that come before the name.
suffix 
array[string] 
Parts that come after the name.
telecom 
array[json] 
Contact details for the individual.
Click to view child attributes
system 
string 
Supported values are **phone** , **fax** , **email** , **pager** , **url** , **sms** , and **other**.
value 
string 
Free text string of the value for this contact point.
use 
string 
Supported values are **home** , **work** , **temp** , **old** and **mobile**.
address 
array[json] 
Address where the related person can be contacted or visited
Click to view child attributes
use 
string 
Supported values are **home** , **work** , **temp** and **old**.
type 
string 
Supported values are **both** , **physical** and **postal**.
line 
array[string] 
List of strings. The first item in the list will be address line 1 in Canvas. The rest of the items in the list will be concatenated to be address line 2.
city 
string 
String representing the city of the address.
district 
string 
District (e.g., county) of the address.
state 
string 
2 letter state abbreviation of the address.
postalCode 
string 
The 5 digit postal code of the address.
country 
string 
The ISO 3166 2 letter country code.
period 
json 
Click to view child attributes
start 
date 
Starting date with inclusive boundary
end 
date 
End date with inclusive boundary, if not ongoing
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/RelatedPerson/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/RelatedPerson/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "RelatedPerson",
          "id": "3fcea5ee-8961-43b4-9d47-3e8a2a625e95",
          "active": true,
          "patient": {
            "reference": "Patient/7982b53c2c35427fbb70afceb83145f8",
            "type": "Patient"
          },
          "relationship": [
            {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                  "code": "ITWINSIS",
                  "display": "identical twin sister"
                }
              ]
            }
          ],
          "name": [
            {
              "family": "Solis",
              "given": [
                "Terry"
              ]
            }
          ],
          "telecom": [
            {
              "system": "phone",
              "value": "5555555555",
              "use": "home"
            },
            {
              "system": "email",
              "value": "solisterry@example.net",
              "use": "home"
            }
          ],
          "address": [
            {
              "use": "home",
              "type": "both",
              "line": [
                "498 Frank Fields Suite 770"
              ],
              "city": "Taylorbury",
              "state": "RI",
              "postalCode": "90298",
              "country": "us"
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown RelatedPerson resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/RelatedPerson?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/RelatedPerson?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Bundle",
          "type": "searchset",
          "total": 1,
          "link": [
            {
              "relation": "self",
              "url": "/RelatedPerson?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
            },
            {
              "relation": "first",
              "url": "/RelatedPerson?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
            },
            {
              "relation": "last",
              "url": "/RelatedPerson?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
            }
          ],
          "entry": [
            {
              "resource": {
                "resourceType": "RelatedPerson",
                "id": "3fcea5ee-8961-43b4-9d47-3e8a2a625e95",
                "active": true,
                "patient": {
                  "reference": "Patient/7982b53c2c35427fbb70afceb83145f8",
                  "type": "Patient"
                },
                "relationship": [
                  {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                        "code": "ITWINSIS",
                        "display": "identical twin sister"
                      }
                    ]
                  }
                ],
                "name": [
                  {
                    "family": "Solis",
                    "given": [
                      "Terry"
                    ]
                  }
                ],
                "telecom": [
                  {
                    "system": "phone",
                    "value": "5555555555",
                    "use": "home"
                  },
                  {
                    "system": "email",
                    "value": "solisterry@example.net",
                    "use": "home"
                  }
                ],
                "address": [
                  {
                    "use": "home",
                    "type": "both",
                    "line": [
                      "498 Frank Fields Suite 770"
                    ],
                    "city": "Taylorbury",
                    "state": "RI",
                    "postalCode": "90298",
                    "country": "us"
                  }
                ]
              }
            }
          ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/relatedperson/


----- BEGIN PAGE https://docs.canvasmedical.com/api/schedule/
### 
A container for slots of time that may be available for booking appointments  
<http://hl7.org/fhir/R4/schedule.html>  
Staff availability is denoted separately at each practice location associated with the organization record. The schedule **id** obtained from a Schedule search is used to search for bookable time slots for appointments.
### Endpoints
get /Schedule
get
/Schedule
#### Schedule search
Returns a list of location/practitioner combinations that is necessary for identifying open slots when booking appointments. This endpoint does not include any parameters.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the schedule.
text 
json 
Text summary of the resource, for human interpretation.
Click to view child attributes
status 
The status of the narrative.
**Value Options Supported:**
  - generated 
div 
Limited xhtml content that contains the human readable text of the Schedule.
actor 
array[json] 
Resource(s) that availability information is being provided for.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/a39cafb9d1b445be95a2e2548e12a787"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
comment 
string 
Comments on availability. Currently the format for this comment will be `Schedule for <practitioner credentialed name> at <location>`
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Schedule' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Schedule"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
          {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 8,
            "entry": [
                {
                    "resource": {
                        "resourceType": "Schedule",
                        "id": "Location.1-Staff.e766816672f34a5b866771c773e38f3c",
                        "text": {
                            "status": "generated",
                            "div": "<div>Schedule for Youta Priti MD at California</div>"
                        },
                        "actor": [
                            {
                                "reference": "Practitioner/e766816672f34a5b866771c773e38f3c",
                                "type": "Practitioner"
                            }
                        ],
                        "comment": "Schedule for Youta Priti MD at California"
                    }
                },
                {
                    "resource": {
                        "resourceType": "Schedule",
                        "id": "Location.1-Staff.77bd177f81b14c9f943e1e30ed3dd989",
                        "text": {
                            "status": "generated",
                            "div": "<div>Schedule for Breanna Heller LMFT at California</div>"
                        },
                        "actor": [
                            {
                                "reference": "Practitioner/77bd177f81b14c9f943e1e30ed3dd989",
                                "type": "Practitioner"
                            }
                        ],
                        "comment": "Schedule for Breanna Heller LMFT at California"
                    }
                },
                {
                    "resource": {
                        "resourceType": "Schedule",
                        "id": "Location.1-Staff.f65c2bed0d8643cc808e25d5cfcf5070",
                        "text": {
                            "status": "generated",
                            "div": "<div>Schedule for Patrick van Nieuwenhuizen MD at California</div>"
                        },
                        "actor": [
                            {
                                "reference": "Practitioner/f65c2bed0d8643cc808e25d5cfcf5070",
                                "type": "Practitioner"
                            }
                        ],
                        "comment": "Schedule for Patrick van Nieuwenhuizen MD at California"
                    }
                },
                {
                    "resource": {
                        "resourceType": "Schedule",
                        "id": "Location.2-Staff.e766816672f34a5b866771c773e38f3c",
                        "text": {
                            "status": "generated",
                            "div": "<div>Schedule for Youta Priti MD at Tennessee</div>"
                        },
                        "actor": [
                            {
                                "reference": "Practitioner/e766816672f34a5b866771c773e38f3c",
                                "type": "Practitioner"
                            }
                        ],
                        "comment": "Schedule for Youta Priti MD at Tennessee"
                    }
                },
                {
                    "resource": {
                        "resourceType": "Schedule",
                        "id": "Location.2-Staff.3a182f42885645e0bc3d608e7c02aad8",
                        "text": {
                            "status": "generated",
                            "div": "<div>Schedule for Nikhil Krishnan MD at Tennessee</div>"
                        },
                        "actor": [
                            {
                                "reference": "Practitioner/3a182f42885645e0bc3d608e7c02aad8",
                                "type": "Practitioner"
                            }
                        ],
                        "comment": "Schedule for Nikhil Krishnan MD at Tennessee"
                    }
                },
                {
                    "resource": {
                        "resourceType": "Schedule",
                        "id": "Location.2-Staff.77bd177f81b14c9f943e1e30ed3dd989",
                        "text": {
                            "status": "generated",
                            "div": "<div>Schedule for Breanna Heller LMFT at Tennessee</div>"
                        },
                        "actor": [
                            {
                                "reference": "Practitioner/77bd177f81b14c9f943e1e30ed3dd989",
                                "type": "Practitioner"
                            }
                        ],
                        "comment": "Schedule for Breanna Heller LMFT at Tennessee"
                    }
                },
                {
                    "resource": {
                        "resourceType": "Schedule",
                        "id": "Location.2-Staff.f65c2bed0d8643cc808e25d5cfcf5070",
                        "text": {
                            "status": "generated",
                            "div": "<div>Schedule for Patrick van Nieuwenhuizen MD at Tennessee</div>"
                        },
                        "actor": [
                            {
                                "reference": "Practitioner/f65c2bed0d8643cc808e25d5cfcf5070",
                                "type": "Practitioner"
                            }
                        ],
                        "comment": "Schedule for Patrick van Nieuwenhuizen MD at Tennessee"
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/schedule/


----- BEGIN PAGE https://docs.canvasmedical.com/api/service-base-urls/
##  FHIR Base URLs 
We leverage the following format.
Customer Subdomain | FHIR Base URL  
---|---  
modernfamilypractice | `https://fumage-modernfamilypractice.canvasmedical.com`  
modernfamilypractice-dev | `https://fumage-modernfamilypractice-dev.canvasmedical.com`  
modernfamilypractice-staging | `https://fumage-modernfamilypractice-staging.canvasmedical.com`  
The global base URLs for our supported Canvas environments can be found using the links below. They are in FHIR R4 Bundle format conformant to the requirements specified in ASTP/ONC's HTI-1 Final Rule (g)(10) criterion.
**Non Production:** [https://docs.canvasmedical.com/assets/static/fhir-service-base-urls-nonproduction.json](/assets/static/fhir-service-base-urls-nonproduction.json)  
**Production:** [https://docs.canvasmedical.com/assets/static/fhir-service-base-urls-production.json](/assets/static/fhir-service-base-urls-production.json)
----- END PAGE https://docs.canvasmedical.com/api/service-base-urls/


----- BEGIN PAGE https://docs.canvasmedical.com/api/servicerequest/
### 
A request for a service to be performed for a patient, such as imaging, laboratory testing, or referral.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-servicerequest.html>  
ServiceRequest represents multiple Canvas services:
  - Imaging orders (e.g., CT, MRI, X-ray) - [Ordering imaging study](https://canvas-medical.help.usepylon.com/articles/2615916315-image-command) \- Laboratory orders (e.g., hemoglobin/hematocrit) - [Placing a lab order](https://canvas-medical.help.usepylon.com/articles/3065191197-placing-a-lab-order) \- Referrals (e.g., patient referral to specialist) - [Referring a patient](https://canvas-medical.help.usepylon.com/articles/8339414277-command-referrals) The ServiceRequest surface reflects these orders via standardized coding:
  - `category` uses SNOMED CT to represent the order category (e.g., Imaging, Laboratory procedure, Referral/Evaluation procedure) - `code` uses LOINC to represent the requested test/procedure
### Endpoints
get /ServiceRequest/{id} get /ServiceRequest
get
/ServiceRequest/{id}
#### ServiceRequest read
Read a ServiceRequest resource.
### Path Parameters
id required
string 
The unique identifier for the ServiceRequest   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the ServiceRequest.
status 
string 
A code specifying the state of the ServiceRequest.
**Value Options Supported:**
  - active 
  - completed 
  - draft 
  - entered-in-error 
intent 
string 
Indicates the level of authorization/intent for the request. Canvas supports `order` for orders placed by a practitioner.
**Value Options Supported:**
  - order 
category 
array[json] 
Categorical classification of the requested service (SNOMED CT). Common examples include Imaging, Laboratory procedure, and Referral/Evaluation procedure.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system URL of the coding.
**Value Options Supported:**
  - http://snomed.info/sct 
code 
string 
The code value.
**Value Options Supported:**
  - 363679005 
  - 108252007 
  - 386053000 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Imaging 
  - Laboratory procedure 
  - Evaluation procedure (procedure) 
code 
json 
What service is being requested in a coded form (typically LOINC).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system URL of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string 
The code value that represents the respective Canvas service/order.
display 
string 
The display name of the coding.
subject 
json 
Who/what the service request is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/c4ff2ee2e41b4636b7d37ac7f9297d95"`.
type 
string 
Type the reference refers to (e.g. "Patient").
occurrencePeriod 
json 
The time window during which the service is to occur.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary of the requested service period.
end 
datetime 
End time with inclusive boundary of the requested service period.
authoredOn 
datetime 
When the request was authored in Canvas.
requester 
json 
Who/what is requesting the service (a Practitioner reference).
Click to view child attributes
reference 
string 
The reference string of the requester in the format of `"Practitioner/5eede137ecfe4124b8b773040e33be14"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
reasonReference 
array[json] 
Reason for the request. References Conditions from Canvas.
Click to view child attributes
reference 
string 
The reference string of the reason in the format of `"Condition/6700a428-6387-458d-8134-0702851da23c"`.
type 
string 
Type the reference refers to (e.g. "Condition").
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/ServiceRequest
#### ServiceRequest search
Search for ServiceRequest resources.
### Query Parameters
****
_id 
string 
The identifier of the ServiceRequest.
patient 
string 
The patient reference associated to the Service Request in the format `Patient/c4ff2ee2e41b4636b7d37ac7f9297d95`.
authored 
date 
Filter by **authoredOn**. See [Date Filtering](/api/date-filtering) for more information.
category 
string 
Categorization of the request (SNOMED CT). Filters by `category.coding` code and/or system. You can search by code alone or `system|code`.
**Search Values Supported:**
  - http://snomed.info/sct|363679005
  - http://snomed.info/sct|108252007
  - http://snomed.info/sct|386053000
code 
string 
What is being requested (typically LOINC). Filters by `code.coding` code and/or system. You can search by code alone or `system|code`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
The identifier of the ServiceRequest.
status 
string 
A code specifying the state of the ServiceRequest.
**Value Options Supported:**
  - active 
  - completed 
  - draft 
  - entered-in-error 
intent 
string 
Indicates the level of authorization/intent for the request. Canvas supports `order` for orders placed by a practitioner.
**Value Options Supported:**
  - order 
category 
array[json] 
Categorical classification of the requested service (SNOMED CT). Common examples include Imaging, Laboratory procedure, and Referral/Evaluation procedure.
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system URL of the coding.
**Value Options Supported:**
  - http://snomed.info/sct 
code 
string 
The code value.
**Value Options Supported:**
  - 363679005 
  - 108252007 
  - 386053000 
display 
string 
The display name of the coding.
**Value Options Supported:**
  - Imaging 
  - Laboratory procedure 
  - Evaluation procedure (procedure) 
code 
json 
What service is being requested in a coded form (typically LOINC).
Click to view child attributes
coding 
array[json] 
Code defined by a terminology system.
Click to view child attributes
system 
string 
The system URL of the coding.
**Value Options Supported:**
  - http://loinc.org 
code 
string 
The code value that represents the respective Canvas service/order.
display 
string 
The display name of the coding.
subject 
json 
Who/what the service request is for.
Click to view child attributes
reference 
string 
The reference string of the subject in the format of `"Patient/c4ff2ee2e41b4636b7d37ac7f9297d95"`.
type 
string 
Type the reference refers to (e.g. "Patient").
occurrencePeriod 
json 
The time window during which the service is to occur.
Click to view child attributes
start 
datetime 
Starting time with inclusive boundary of the requested service period.
end 
datetime 
End time with inclusive boundary of the requested service period.
authoredOn 
datetime 
When the request was authored in Canvas.
requester 
json 
Who/what is requesting the service (a Practitioner reference).
Click to view child attributes
reference 
string 
The reference string of the requester in the format of `"Practitioner/5eede137ecfe4124b8b773040e33be14"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
reasonReference 
array[json] 
Reason for the request. References Conditions from Canvas.
Click to view child attributes
reference 
string 
The reference string of the reason in the format of `"Condition/6700a428-6387-458d-8134-0702851da23c"`.
type 
string 
Type the reference refers to (e.g. "Condition").
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/ServiceRequest/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/ServiceRequest/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "ServiceRequest",
            "id": "a47c7b0e-bbb4-42cd-bc4a-df259d148ea1",
            "status": "active",
            "intent": "order",
            "category": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "363679005",
                    "display": "Imaging"
                  }
                ]
              }
            ],
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "24627-2",
                  "display": "CT Chest"
                }
              ]
            },
            "subject": {
              "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
              "type": "Patient"
            },
            "occurrencePeriod": {
              "start": "2025-10-01T09:00:00+00:00",
              "end": "2025-10-01T09:30:00+00:00"
            },
            "authoredOn": "2025-09-30T19:12:25.073749+00:00",
            "requester": {
              "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
              "type": "Practitioner"
            },
            "reasonReference": [
              {
                "reference": "Condition/6700a428-6387-458d-8134-0702851da23c"
              }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown ServiceRequest resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/ServiceRequest?patient=Patient/c4ff2ee2e41b4636b7d37ac7f9297d95' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/ServiceRequest?patient=Patient/c4ff2ee2e41b4636b7d37ac7f9297d95"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Bundle",
          "type": "searchset",
          "total": 3,
          "link": [
            {
              "relation": "self",
              "url": "/ServiceRequest?patient=Patient%2Fc4ff2ee2e41b4636b7d37ac7f9297d95&_count=10&_offset=0"
            },
            {
              "relation": "first",
              "url": "/ServiceRequest?patient=Patient%2Fc4ff2ee2e41b4636b7d37ac7f9297d95&_count=10&_offset=0"
            },
            {
              "relation": "last",
              "url": "/ServiceRequest?patient=Patient%2Fc4ff2ee2e41b4636b7d37ac7f9297d95&_count=10&_offset=0"
            }
          ],
          "entry": [
            {
              "resource": {
                "resourceType": "ServiceRequest",
                "id": "bef0e33b-5008-489b-aa32-873b99e1e523",
                "status": "active",
                "intent": "order",
                "category": [
                  {
                    "coding": [
                      {
                        "system": "http://snomed.info/sct",
                        "code": "363679005",
                        "display": "Imaging"
                      }
                    ]
                  }
                ],
                "code": {
                  "coding": [
                    {
                      "system": "http://loinc.org",
                      "code": "24627-2",
                      "display": "CT Chest"
                    }
                  ]
                },
                "subject": {
                  "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
                  "type": "Patient"
                },
                "occurrencePeriod": {
                  "start": "2025-10-01T09:00:00+00:00",
                  "end": "2025-10-01T09:30:00+00:00"
                },
                "authoredOn": "2025-09-30T19:12:25.073749+00:00",
                "requester": {
                  "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                  "type": "Practitioner"
                },
                "reasonReference": [
                  {
                    "reference": "Condition/6700a428-6387-458d-8134-0702851da23c"
                  }
                ]
              }
            },
            {
              "resource": {
                "resourceType": "ServiceRequest",
                "id": "5938a56b-0239-47c5-ad31-703ca5104bb5",
                "status": "draft",
                "intent": "order",
                "category": [
                  {
                    "coding": [
                      {
                        "system": "http://snomed.info/sct",
                        "code": "108252007",
                        "display": "Laboratory procedure"
                      }
                    ]
                  }
                ],
                "code": {
                  "coding": [
                    {
                      "system": "http://loinc.org",
                      "code": "4544-3",
                      "display": "Hematocrit"
                    },
                    {
                      "system": "http://loinc.org",
                      "code": "718-7",
                      "display": "Hemoglobin"
                    }
                  ]
                },
                "subject": {
                  "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
                  "type": "Patient"
                },
                "occurrencePeriod": {
                  "start": "2025-10-01T09:00:00+00:00",
                  "end": "2025-10-01T09:30:00+00:00"
                },
                "authoredOn": "2025-09-30T19:12:25.100394+00:00",
                "requester": {
                  "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                  "type": "Practitioner"
                },
                "reasonReference": [
                  {
                    "reference": "Condition/2db04232-de4f-4d59-8066-2e5cee1c2a1d"
                  }
                ]
              }
            },
            {
              "resource": {
                "resourceType": "ServiceRequest",
                "id": "db35b108-a9f3-4d70-bc76-4c4800bce005",
                "status": "completed",
                "intent": "order",
                "category": [
                  {
                    "coding": [
                      {
                        "system": "http://snomed.info/sct",
                        "code": "386053000",
                        "display": "Evaluation procedure (procedure)"
                      }
                    ]
                  }
                ],
                "code": {
                  "coding": [
                    {
                      "system": "http://loinc.org",
                      "code": "103696004",
                      "display": "Patient referral to specialist"
                    }
                  ]
                },
                "subject": {
                  "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
                  "type": "Patient"
                },
                "occurrencePeriod": {
                  "start": "2025-10-01T09:00:00+00:00",
                  "end": "2025-10-01T09:30:00+00:00"
                },
                "authoredOn": "2025-09-30T19:12:25.121629+00:00",
                "requester": {
                  "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
                  "type": "Practitioner"
                },
                "reasonReference": [
                  {
                    "reference": "Condition/691a6afa-a450-425e-a151-26b20f595efb"
                  }
                ]
              }
            }
          ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/servicerequest/


----- BEGIN PAGE https://docs.canvasmedical.com/api/slot/
### 
A slot of time on a schedule that may be available for booking appointments.  
<http://hl7.org/fhir/R4/slot.html>  
All slots are determined through our Google Calendar integration. Find out how to set this up [here](https://help.canvasmedical.com/articles/6105998178-managing-provider-availability).
### Endpoints
get /Slot
get
/Slot
#### Slot search
Search for available appointment slots
### Query Parameters
**A Slot Search requires a schedule search parameter.**
duration 
integer 
If included, the request will search for available appointment slots with the given duration value in minutes. If not provided, a duration of 20 minutes will be used.
end 
date 
If included, the request will search for available appointment slots up until this date. If not included, a week will be used as default (7 days from the start date).
schedule 
string 
The Schedule Resource that we are seeking a slot within. The [Schedule](/api/schedule) resource can be used to retrieve a list of Schedule ids.
start 
date 
If included, the request will search for available appointment slots on or after this date. If not included, the current UTC date will be used.
appointment-type 
string 
Filters by the code and system of the allowed appointment type (if specificied in admin). Use the format `system|code` (e.g `http://snomed.info/sct|185418009`).
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
schedule 
json 
The [Schedule](/api/schedule) resource that this slot belongs to.
Click to view child attributes
reference 
string 
The reference string of the schedule in the format of `"Schedule/Location.<location_id>-Staff.<staff_id>"`.
type 
string 
Type the reference refers to (e.g. "Schedule").
status 
string 
The status of the available slot. Canvas only returns slots that are available for booking, so this field will always be returned as **free**.
**Value Options Supported:**
  - free 
start 
datetime 
Date/Time that the slot is to begin.
end 
datetime 
Date/Time that the slot is to conclude
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Slot?schedule=Location.2-Staff.3640cd20de8a470aa570a852859ac87e&start=2023-09-21&end=2023-09-23&duration=20' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Slot?schedule=Location.2-Staff.3640cd20de8a470aa570a852859ac87e&start=2023-09-21&end=2023-09-23&duration=20"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 3,
            "entry":
            [
                {
                    "resource":
                    {
                        "resourceType": "Slot",
                        "schedule":
                        {
                            "reference": "Schedule/Location.2-Staff.3640cd20de8a470aa570a852859ac87e",
                            "type": "Schedule"
                        },
                        "status": "free",
                        "start": "2023-09-21T08:45:00-07:00",
                        "end": "2023-09-21T09:05:00-07:00"
                    }
                },
                {
                    "resource":
                    {
                        "resourceType": "Slot",
                        "schedule":
                        {
                            "reference": "Schedule/Location.2-Staff.3640cd20de8a470aa570a852859ac87e",
                            "type": "Schedule"
                        },
                        "status": "free",
                        "start": "2023-09-21T13:45:00-07:00",
                        "end": "2023-09-21T14:05:00-07:00"
                    }
                },
                {
                    "resource":
                    {
                        "resourceType": "Slot",
                        "schedule":
                        {
                            "reference": "Schedule/Location.2-Staff.3640cd20de8a470aa570a852859ac87e",
                            "type": "Schedule"
                        },
                        "status": "free",
                        "start": "2023-09-22T09:15:00-07:00",
                        "end": "2023-09-22T09:35:00-07:00"
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/slot/


----- BEGIN PAGE https://docs.canvasmedical.com/api/software-requirements/
###  Mandatory Software Components 
In order to access the FHIR API, a REST client such as [Bruno](https://www.usebruno.com/), or a high-level language (Java, Python, etc) that can be used to make HTTP requests, is needed.
###  Mandatory Software Configuration 
In order to use the API, an application needs to be created in your Canvas instance as described in ["Customer Authentication".](/api/customer-authentication)
###  All Technical Requirements and Attributes Necessary for Registration 
See above ("Mandatory Software Configuration").
----- END PAGE https://docs.canvasmedical.com/api/software-requirements/


----- BEGIN PAGE https://docs.canvasmedical.com/api/specimen/
### 
A sample to be used for analysis.  
<https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-specimen.html>
### Endpoints
get /Specimen/{id} get /Specimen
get
/Specimen/{id}
#### Specimen read
Read a Specimen resource.
### Path Parameters
id required
string 
The unique identifier for the Specimen   
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
Unique Canvas identifier for this resource.
type 
json 
Kind of material that forms the specimen.
Click to view child attributes
text 
string 
Free-text description of the specimen type (e.g. "Serum").
subject 
json 
The patient from whom the specimen was collected.
Click to view child attributes
reference 
string 
The patient reference in the format `Patient/<patient_id>`.
type 
string 
Type the reference refers to (e.g. `Patient`).
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
get
/Specimen
#### Specimen search
Search for Specimen resources.
### Query Parameters
****
_id 
string 
A Canvas-issued unique identifier for a specific Specimen.
patient 
string 
The patient reference associated to the Specimen using the format `Patient/<patient_id>`.
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
resourceType 
string 
The FHIR Resource name.
id 
string 
Unique Canvas identifier for this resource.
type 
json 
Kind of material that forms the specimen.
Click to view child attributes
text 
string 
Free-text description of the specimen type (e.g. "Serum").
subject 
json 
The patient from whom the specimen was collected.
Click to view child attributes
reference 
string 
The patient reference in the format `Patient/<patient_id>`.
type 
string 
Type the reference refers to (e.g. `Patient`).
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Specimen/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Specimen/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Specimen",
          "id": "0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d",
          "type": {
            "text": "Serum"
          },
          "subject": {
            "reference": "Patient/1c8c6f27551d4d01aa3bf2477a4d5259",
            "type": "Patient"
          }
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Specimen resource 'SPM-unknown'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Specimen?_id=0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d&patient=Patient/1c8c6f27551d4d01aa3bf2477a4d5259' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Specimen?_id=0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d&patient=Patient/1c8c6f27551d4d01aa3bf2477a4d5259"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
          "resourceType": "Bundle",
          "type": "searchset",
          "total": 1,
          "link": [
            {
              "relation": "self",
              "url": "/Specimen?_id=0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d&patient=Patient/1c8c6f27551d4d01aa3bf2477a4d5259&_count=10&_offset=0"
            },
            {
              "relation": "first",
              "url": "/Specimen?_id=0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d&patient=Patient/1c8c6f27551d4d01aa3bf2477a4d5259&_count=10&_offset=0"
            },
            {
              "relation": "last",
              "url": "/Specimen?_id=0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d&patient=Patient/1c8c6f27551d4d01aa3bf2477a4d5259&_count=10&_offset=0"
            }
          ],
          "entry": [
            {
              "resource": {
                "resourceType": "Specimen",
                "id": "0a5d9e1f-1c64-4d04-a2bb-2a58e34f9f6d",
                "type": {
                  "text": "Serum"
                },
                "subject": {
                  "reference": "Patient/1c8c6f27551d4d01aa3bf2477a4d5259",
                  "type": "Patient"
                }
              }
            }
          ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/specimen/


----- BEGIN PAGE https://docs.canvasmedical.com/api/task/
### 
A task to be performed.  
<http://hl7.org/fhir/R4/task.html>   
To read more about tasks in Canvas see [this article](https://canvas-medical.help.usepylon.com/articles/8460447495-task-management).
### Endpoints
post /Task get /Task/{id} put /Task/{id} get /Task
post
/Task
#### Task create
Create a task.  
Tasks created through this FHIR Endpoint will display in the [patient chart via the tasks icon](https://canvas-medical.help.usepylon.com/articles/8460447495-task-management#tasks-in-the-patient-chart-12). Open tasks will also display in the [Task Panel](https://canvas-medical.help.usepylon.com/articles/8460447495-task-management#task-list-16).
### Attributes
extension 
array[json] 
Additional content defined by implementations  
  - Canvas supports assigning a task to a group/team. This optional field requires a reference to the team from the [FHIR Group](/api/group) endpoint. In the Canvas UI, this will display under the field **team** in the task card.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/task-group (This url will have an associated valueReference for the FHIR Group that this task is assigned to.)
valueReference 
json 
A reference to a FHIR Group resource that represents the canvas team assigned to the task.
Click to view child attributes
reference 
string required
The reference string of the group in the format of `"Group/13f3941f-0b51-4409-9a2f-e2f0353b324e"`.
status 
string required
The current status of the task.
**Value Options Supported:**
  - requested (In canvas this maps to a status of open.)
  - completed 
  - cancelled (In canvas this maps to a status of closed.)
priority 
string 
The priority level of the task.
**Value Options Supported:**
  - stat 
  - urgent 
  - routine 
description 
string required
Human-readable explanation of task.
for 
json 
Beneficiary of the Task. This must be a [Patient](/api/patient) reference. If this attribute is supplied, the task will be visible on the patient's chart.
Click to view child attributes
reference 
string required
The reference string of the patient in the format of `"Patient/cfd91cd3bd9046db81199aa8ee4afd7f"`.
authoredOn 
datetime 
Task Creation Date. If omitted from the message, it will default to the current timestamp at the time of ingestion.
requester 
json required
Who is asking for task to be done. This must be a [Practitioner](/api/practitioner) reference.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
owner 
json 
Responsible individual. If supplied, this must be a [Practitioner](/api/practitioner) reference. In canvas this practitioner will become the staff member assignee.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
intent 
enum [unknown] required
Distinguishes whether the task is a proposal, plan or full order. Canvas does not have a mapping for this field, so it should always be set to **unknown**.
restriction 
json 
Constraints on fulfillment tasks. In Canvas, this field is used to represent the due date for a task.
Click to view child attributes
period 
json 
When fulfillment sought.
Click to view child attributes
end 
datetime 
Due date for the task to be performed by.
note 
array[json] 
Comments made about the task.
For each comment, the following values can be specified:
  - The comment's text
  - Timestamp the comment was left. If omitted, this will default to current timestamp at data ingestion.
  - Reference to the practitioner that left the specific comment
Click to view child attributes
text 
string required
The text of the task comment.
time 
datetime 
The timestamp the comment was left on the task. If omitted, this will default to current timestamp at data ingestion.
authorReference 
json required
A reference to the Canvas Practitioner who authored the task comment.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
input 
array[json] 
Information used to perform the task. In Canvas this translates to added labels on a Task.
If the label doesn't exist in Canvas already, it will be created.   
When labels are created or updated through the Task endpoint, Canvas automatically scopes them to the Tasks module. If you reference an existing label that does not yet include the Tasks module, Canvas adds it during ingestion. Labels with an empty `modules` array remain global and continue to work across every module.
Click to view child attributes
type 
json required
Label for the input.
Click to view child attributes
text 
string required
**Value Options Supported:**
  - label 
valueString 
string required
Name of the label. If the label doesn't exist in Canvas already, it will be created.
### Responses
201 Created 
The server has successfully processed the request; the new resource has been created and is now ready for interaction.  
Canvas returns the created resource's id as a UUID within the `location` header and a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Task/{id}
#### Task read
Read a Task resource.
### Path Parameters
id required
string 
The unique identifier for the Task   
### Response Payload Attributes
id 
string 
The identifier of the task.
extension 
array[json] 
Additional content defined by implementations  
  - Canvas supports assigning a task to a group/team. This optional field requires a reference to the team from the [FHIR Group](/api/group) endpoint. In the Canvas UI, this will display under the field **team** in the task card.
  - When reading our a FHIR Task objects, a permalink URL to the task may be supplied. This link will take you directly to the task in the Canvas UI.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/task-permalink (This url will have an associated valueString with a url that will directly link to the task in the Canvas UI.)
  - http://schemas.canvasmedical.com/fhir/extensions/task-group (This url will have an associated valueReference for the FHIR Group that this task is assigned to.)
valueString 
string 
Supplied in the extensions associated to the permalink. This string will represent a URL to the task in the Canvas UI.
valueReference 
json 
A reference to a FHIR Group resource that represents the canvas team assigned to the task.
Click to view child attributes
reference 
string 
The reference string of the group in the format of `"Group/13f3941f-0b51-4409-9a2f-e2f0353b324e"`.
type 
string 
Type the reference refers to (e.g. "Group").
display 
string 
Display name of the FHIR Group.
status 
string 
The current status of the task.
**Value Options Supported:**
  - requested (In canvas this maps to a status of open.)
  - completed 
  - cancelled (In canvas this maps to a status of closed.)
priority 
string 
The priority level of the task.
**Value Options Supported:**
  - stat 
  - urgent 
  - routine 
description 
string 
Human-readable explanation of task.
for 
json 
Beneficiary of the Task. This must be a [Patient](/api/patient) reference. If this attribute is supplied, the task will be visible on the patient's chart.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/cfd91cd3bd9046db81199aa8ee4afd7f"`.
type 
string 
Type the reference refers to (e.g. "Patient").
authoredOn 
datetime 
Task Creation Date. If omitted from the message, it will default to the current timestamp at the time of ingestion.
lastModified 
datetime 
Task Update Date. Whenever the task receieves any updates, including comments, this field will be updated accordingly.
requester 
json 
Who is asking for task to be done. This must be a [Practitioner](/api/practitioner) reference.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
owner 
json 
Responsible individual. If supplied, this must be a [Practitioner](/api/practitioner) reference. In canvas this practitioner will become the staff member assignee.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
intent 
enum [unknown] 
Distinguishes whether the task is a proposal, plan or full order. Canvas does not have a mapping for this field, so it should always be set to **unknown**.
restriction 
json 
Constraints on fulfillment tasks. In Canvas, this field is used to represent the due date for a task.
Click to view child attributes
period 
json 
When fulfillment sought.
Click to view child attributes
end 
datetime 
Due date for the task to be performed by.
note 
array[json] 
Comments made about the task.
Click to view child attributes
text 
string 
The text of the task comment.
time 
datetime 
The timestamp the comment was left on the task. If omitted, this will default to current timestamp at data ingestion.
authorReference 
json 
A reference to the Canvas Practitioner who authored the task comment.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
input 
array[json] 
Information used to perform the task. In Canvas this translates to added labels on a Task.
Click to view child attributes
type 
json 
Label for the input.
Click to view child attributes
text 
string 
**Value Options Supported:**
  - label 
valueString 
string 
Name of the label. If the label doesn't exist in Canvas already, it will be created.
### Responses
200 OK 
Request was successful. 
### Errors
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
put
/Task/{id}
#### Task update
Update a task.  
Omitting the group `extension` and `authoredOn` fields in an update body does not delete the contents of that field. They will remain set to the last value they were assigned.  
Omitting the `description`, `owner`, `restriction` and `input` attributes will delete the contents of the field in the Canvas database. In order to have a Task keep the values in these fields after an update, they must be included.
### Attributes
id 
string required
The identifier of the task.
extension 
array[json] 
Additional content defined by implementations  
  - Canvas supports assigning a task to a group/team. This optional field requires a reference to the team from the [FHIR Group](/api/group) endpoint. In the Canvas UI, this will display under the field **team** in the task card.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/task-group (This url will have an associated valueReference for the FHIR Group that this task is assigned to.)
valueReference 
json 
A reference to a FHIR Group resource that represents the canvas team assigned to the task.
Click to view child attributes
reference 
string required
The reference string of the group in the format of `"Group/13f3941f-0b51-4409-9a2f-e2f0353b324e"`.
status 
string required
The current status of the task.
**Value Options Supported:**
  - requested (In canvas this maps to a status of open.)
  - completed 
  - cancelled (In canvas this maps to a status of closed.)
priority 
string 
The priority level of the task.
**Value Options Supported:**
  - stat 
  - urgent 
  - routine 
description 
string required
Human-readable explanation of task.
for 
json 
Beneficiary of the Task. This must be a [Patient](/api/patient) reference. If this attribute is supplied, the task will be visible on the patient's chart.
Click to view child attributes
reference 
string required
The reference string of the patient in the format of `"Patient/cfd91cd3bd9046db81199aa8ee4afd7f"`.
authoredOn 
datetime 
Task Creation Date. If omitted from the message, it will default to the current timestamp at the time of ingestion.
requester 
json required
Who is asking for task to be done. This must be a [Practitioner](/api/practitioner) reference.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
owner 
json 
Responsible individual. If supplied, this must be a [Practitioner](/api/practitioner) reference. In canvas this practitioner will become the staff member assignee.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
intent 
enum [unknown] required
Distinguishes whether the task is a proposal, plan or full order. Canvas does not have a mapping for this field, so it should always be set to **unknown**.
restriction 
json 
Constraints on fulfillment tasks. In Canvas, this field is used to represent the due date for a task.
Click to view child attributes
period 
json 
When fulfillment sought.
Click to view child attributes
end 
datetime 
Due date for the task to be performed by.
note 
array[json] 
Comments made about the task.
For each comment, the following values can be specified:
  - The comment's text
  - Timestamp the comment was left. If omitted, this will default to current timestamp at data ingestion.
  - Reference to the practitioner that left the specific comment
Click to view child attributes
text 
string required
The text of the task comment.
time 
datetime 
The timestamp the comment was left on the task. If omitted, this will default to current timestamp at data ingestion.
authorReference 
json required
A reference to the Canvas Practitioner who authored the task comment.
Click to view child attributes
reference 
string required
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
input 
array[json] 
Information used to perform the task. In Canvas this translates to added labels on a Task.
If the label doesn't exist in Canvas already, it will be created.   
When labels are created or updated through the Task endpoint, Canvas automatically scopes them to the Tasks module. If you reference an existing label that does not yet include the Tasks module, Canvas adds it during ingestion. Labels with an empty `modules` array remain global and continue to work across every module.
Click to view child attributes
type 
json required
Label for the input.
Click to view child attributes
text 
string required
**Value Options Supported:**
  - label 
valueString 
string required
Name of the label. If the label doesn't exist in Canvas already, it will be created.
### Responses
200 OK 
The server has successfully processed the request.  
Canvas returns a `null` response body. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
404 Not Found 
The requested resource was not found. 
405 Method Not Allowed 
The request performs an operation that is either not supported or allowed. 
412 Precondition Failed 
The request depends on a precondition that has not been met. 
422 Unprocessable Entity 
The request cannot be processed due to semantic issues or conflicts with the database state. 
get
/Task
#### Task search
Search for a task
### Query Parameters
****
_id 
string 
Search by a task id.
_sort 
string 
Triggers sorting of the results by a specific criteria.
**Search Values Supported:**
  - _id (sort in ascending order)
  - due-date (sort in ascending order)
  - -_id (sort in descending order)
  - -due-date (sort in descending order)
description 
string 
Search by description.
due 
string 
Filter by due date and time. See [Date Filtering](/api/date-filtering) for more information.
label 
string 
Search for a task with an associated label
modified 
string 
Filter by modified date and time. See [Date Filtering](/api/date-filtering) for more information.
owner 
string 
Search by task owner in the format `Practitioner/3a9cafb9d1b445be95a2e2548e12a787`.
patient 
string 
Search by patient in the format `Patient/a39cafb9d1b445be95a2e2548e12a787`.
priority 
string 
Search by task priority
**Search Values Supported:**
  - stat
  - urgent
  - routine
requester 
string 
Search by task requester in the format `Practitioner/3a9cafb9d1b445be95a2e2548e12a787`.
status 
string 
Search by task status
**Search Values Supported:**
  - requested
  - completed
  - cancelled
### Response Payload Attributes
resourceType 
string 
The FHIR Resource name.
type 
string 
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
total 
integer 
The number of resources that match the search parameter.
link 
array[json] 
Attributes relevant to pagination, see our [Pagination page](/api/pagination) for more detail.
Click to view child attributes
relation 
enum [self|first|next|last] 
The relation of the page search
url 
The search url for the specific relation
entry 
array[json] 
The results bundle that lists out each object returned in the search
Click to view child attributes
resource 
json 
The attributes specific to the resource type, see the Attributes section below
### Attributes
id 
string 
The identifier of the task.
extension 
array[json] 
Additional content defined by implementations  
  - Canvas supports assigning a task to a group/team. This optional field requires a reference to the team from the [FHIR Group](/api/group) endpoint. In the Canvas UI, this will display under the field **team** in the task card.
  - When reading our a FHIR Task objects, a permalink URL to the task may be supplied. This link will take you directly to the task in the Canvas UI.
Click to view child attributes
url 
string 
Reference that defines the content of this object.
**Value Options Supported:**
  - http://schemas.canvasmedical.com/fhir/extensions/task-permalink (This url will have an associated valueString with a url that will directly link to the task in the Canvas UI.)
  - http://schemas.canvasmedical.com/fhir/extensions/task-group (This url will have an associated valueReference for the FHIR Group that this task is assigned to.)
valueString 
string 
Supplied in the extensions associated to the permalink. This string will represent a URL to the task in the Canvas UI.
valueReference 
json 
A reference to a FHIR Group resource that represents the canvas team assigned to the task.
Click to view child attributes
reference 
string 
The reference string of the group in the format of `"Group/13f3941f-0b51-4409-9a2f-e2f0353b324e"`.
type 
string 
Type the reference refers to (e.g. "Group").
display 
string 
Display name of the FHIR Group.
status 
string 
The current status of the task.
**Value Options Supported:**
  - requested (In canvas this maps to a status of open.)
  - completed 
  - cancelled (In canvas this maps to a status of closed.)
priority 
string 
The priority level of the task.
**Value Options Supported:**
  - stat 
  - urgent 
  - routine 
description 
string 
Human-readable explanation of task.
for 
json 
Beneficiary of the Task. This must be a [Patient](/api/patient) reference. If this attribute is supplied, the task will be visible on the patient's chart.
Click to view child attributes
reference 
string 
The reference string of the patient in the format of `"Patient/cfd91cd3bd9046db81199aa8ee4afd7f"`.
type 
string 
Type the reference refers to (e.g. "Patient").
authoredOn 
datetime 
Task Creation Date. If omitted from the message, it will default to the current timestamp at the time of ingestion.
lastModified 
datetime 
Task Update Date. Whenever the task receieves any updates, including comments, this field will be updated accordingly.
requester 
json 
Who is asking for task to be done. This must be a [Practitioner](/api/practitioner) reference.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
owner 
json 
Responsible individual. If supplied, this must be a [Practitioner](/api/practitioner) reference. In canvas this practitioner will become the staff member assignee.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
intent 
enum [unknown] 
Distinguishes whether the task is a proposal, plan or full order. Canvas does not have a mapping for this field, so it should always be set to **unknown**.
restriction 
json 
Constraints on fulfillment tasks. In Canvas, this field is used to represent the due date for a task.
Click to view child attributes
period 
json 
When fulfillment sought.
Click to view child attributes
end 
datetime 
Due date for the task to be performed by.
note 
array[json] 
Comments made about the task.
Click to view child attributes
text 
string 
The text of the task comment.
time 
datetime 
The timestamp the comment was left on the task. If omitted, this will default to current timestamp at data ingestion.
authorReference 
json 
A reference to the Canvas Practitioner who authored the task comment.
Click to view child attributes
reference 
string 
The reference string of the practitioner in the format of `"Practitioner/4150cd20de8a470aa570a852859ac87e"`.
type 
string 
Type the reference refers to (e.g. "Practitioner").
input 
array[json] 
Information used to perform the task. In Canvas this translates to added labels on a Task.
Click to view child attributes
type 
json 
Label for the input.
Click to view child attributes
text 
string 
**Value Options Supported:**
  - label 
valueString 
string 
Name of the label. If the label doesn't exist in Canvas already, it will be created.
### Responses
200 OK 
Request was successful. 
### Errors
400 Bad Request 
The request was invalid or cannot be otherwise served. An accompanying error message will explain further. 
401 Unauthorized 
The request requires user authentication. 
403 Forbidden 
The request requires user authorization. 
  - **curl**
        ```sh
        curl --request POST \
             --url 'https://fumage-example.canvasmedical.com/Task' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Task",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/task-group",
                    "valueReference": {
                        "reference": "Group/0c59ba86-dd40-4fde-8179-6e0b91dc617b"
                    }
                }
            ],
            "status": "requested",
            "priority": "urgent",
            "description": "Ask patient for new insurance information.",
            "for": { "reference": "Patient/cfd91cd3bd9046db81199aa8ee4afd7f" },
            "authoredOn": "2023-09-22T14:00:00.000Z",
            "requester": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" },
            "owner": { "reference": "Practitioner/a02cbf2403e140f7bc9a355c6ed420f3" },
            "intent": "unknown",
            "restriction": { "period": { "end": "2023-09-23T14:00:00.000Z" } },
            "note": [
                {
                    "text": "Please call patient to update insurance information.",
                    "time": "2023-09-22T14:00:00.000Z",
                    "authorReference": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" }
                }
            ],
            "input": [
                {
                    "type": { "text": "label" },
                    "valueString": "Urgent"
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Task"
        payload = {
            "resourceType": "Task",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/task-group",
                    "valueReference": {
                        "reference": "Group/0c59ba86-dd40-4fde-8179-6e0b91dc617b"
                    }
                }
            ],
            "status": "requested",
            "priority": "urgent",
            "description": "Ask patient for new insurance information.",
            "for": { "reference": "Patient/cfd91cd3bd9046db81199aa8ee4afd7f" },
            "authoredOn": "2023-09-22T14:00:00.000Z",
            "requester": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" },
            "owner": { "reference": "Practitioner/a02cbf2403e140f7bc9a355c6ed420f3" },
            "intent": "unknown",
            "restriction": { "period": { "end": "2023-09-23T14:00:00.000Z" } },
            "note": [
                {
                    "text": "Please call patient to update insurance information.",
                    "time": "2023-09-22T14:00:00.000Z",
                    "authorReference": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" }
                }
            ],
            "input": [
                {
                    "type": { "text": "label" },
                    "valueString": "Urgent"
                }
            ]
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.post(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **201**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Task/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Task/<id>"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
         {
            "resourceType": "Task",
            "id": "5f72fbcc-10ac-48ff-a2d2-02b229c38ce9",
            "extension":
            [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/task-group",
                    "valueReference":
                    {
                        "reference": "Group/0c59ba86-dd40-4fde-8179-6e0b91dc617b",
                        "type": "Group",
                        "display": "Payment Collection"
                    }
                },
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/task-permalink",
                    "valueString": "http://example.canvasmedical.com/permalinks/v1/VGFzazo4OTo3MA=="
                }
            ],
            "status": "completed",
            "priority": "urgent",
            "description": "Ask patient for new insurance information.",
            "for":
            {
                "reference": "Patient/cfd91cd3bd9046db81199aa8ee4afd7f",
                "type": "Patient"
            },
            "authoredOn": "2023-09-22T14:00:00+00:00",
            "lastModified": "2023-10-22T21:06:27.893521+00:00",
            "requester":
            {
                "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                "type": "Practitioner"
            },
            "owner":
            {
                "reference": "Practitioner/a02cbf2403e140f7bc9a355c6ed420f3",
                "type": "Practitioner"
            },
            "intent": "unknown",
            "restriction":
            {
                "period":
                {
                    "end": "2023-09-23T14:00:00+00:00"
                }
            },
            "note":
            [
                {
                    "authorReference":
                    {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner"
                    },
                    "time": "2023-09-22T14:00:00+00:00",
                    "text": "Please call patient to update insurance information."
                }
            ],
            "input":
            [
                {
                    "type":
                    {
                        "text": "label"
                    },
                    "valueString": "Urgent"
                }
            ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Task resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **curl**
        ```sh
        curl --request PUT \
             --url 'https://fumage-example.canvasmedical.com/Task/<id>' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json' \
             --header 'content-type: application/json' \
             --data '
        {
            "resourceType": "Task",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/task-group",
                    "valueReference": {
                        "reference": "Group/0c59ba86-dd40-4fde-8179-6e0b91dc617b"
                    }
                }
            ],
            "status": "completed",
            "priority": "urgent",
            "description": "Ask patient for new insurance information.",
            "for": { "reference": "Patient/cfd91cd3bd9046db81199aa8ee4afd7f" },
            "authoredOn": "2023-09-22T14:00:00.000Z",
            "requester": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" },
            "owner": { "reference": "Practitioner/a02cbf2403e140f7bc9a355c6ed420f3" },
            "intent": "unknown",
            "restriction": { "period": { "end": "2023-09-23T14:00:00.000Z" } },
            "note": [
                {
                    "text": "Please call patient to update insurance information.",
                    "time": "2023-09-22T14:00:00.000Z",
                    "authorReference": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" }
                }
            ],
            "input": [
                {
                    "type": { "text": "label" },
                    "valueString": "Urgent"
                }
            ]
        }
        '
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Task/<id>"
        payload = {
            "resourceType": "Task",
            "extension": [
                {
                    "url": "http://schemas.canvasmedical.com/fhir/extensions/task-group",
                    "valueReference": {
                        "reference": "Group/0c59ba86-dd40-4fde-8179-6e0b91dc617b"
                    }
                }
            ],
            "status": "completed",
            "priority": "urgent",
            "description": "Ask patient for new insurance information.",
            "for": { "reference": "Patient/cfd91cd3bd9046db81199aa8ee4afd7f" },
            "authoredOn": "2023-09-22T14:00:00.000Z",
            "requester": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" },
            "owner": { "reference": "Practitioner/a02cbf2403e140f7bc9a355c6ed420f3" },
            "intent": "unknown",
            "restriction": { "period": { "end": "2023-09-23T14:00:00.000Z" } },
            "note": [
                {
                    "text": "Please call patient to update insurance information.",
                    "time": "2023-09-22T14:00:00.000Z",
                    "authorReference": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e" }
                }
            ],
            "input": [
                {
                    "type": { "text": "label" },
                    "valueString": "Urgent"
                }
            ]
        }
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>",
            "content-type": "application/json"
        }
        response = requests.put(url, json=payload, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        null
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
  - **404**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-found",
              "details": {
                "text": "Unknown Task resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
              }
            }
          ]
        }
        ```
  - **405**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "not-supported",
              "details": {
                "text": "Operation is not supported"
              }
            }
          ]
        }
        ```
  - **412**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "conflict",
              "details": {
                "text": "Resource updated since If-Unmodified-Since date"
              }
            }
          ]
        }
        ```
  - **422**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "business-rule",
              "details": {
                "text": "Unprocessable entity"
              }
            }
          ]
        }
        ```
  - **curl**
        ```shell
        curl --request GET \
             --url 'https://fumage-example.canvasmedical.com/Task?owner=Practitioner/a02cbf2403e140f7bc9a355c6ed420f3&label=Urgent' \
             --header 'Authorization: Bearer <token>' \
             --header 'accept: application/json'
        ```
  - **python**
        ```python
        import requests
        url = "https://fumage-example.canvasmedical.com/Task?owner=Practitioner/a02cbf2403e140f7bc9a355c6ed420f3&label=Urgent"
        headers = {
            "accept": "application/json",
            "Authorization": "Bearer <token>"
        }
        response = requests.get(url, headers=headers)
        print(response.text)
        ```
  - **200**
        ```json
        {
            "resourceType": "Bundle",
            "type": "searchset",
            "total": 1,
            "link":
            [
                {
                    "relation": "self",
                    "url": "/Task?owner=Practitioner%2Fa02cbf2403e140f7bc9a355c6ed420f3&label=Urgent&_count=10&_offset=0"
                },
                {
                    "relation": "first",
                    "url": "/Task?owner=Practitioner%2Fa02cbf2403e140f7bc9a355c6ed420f3&label=Urgent&_count=10&_offset=0"
                },
                {
                    "relation": "last",
                    "url": "/Task?owner=Practitioner%2Fa02cbf2403e140f7bc9a355c6ed420f3&label=Urgent&_count=10&_offset=0"
                }
            ],
            "entry":
            [
                {
                    "resource":
                    {
                        "resourceType": "Task",
                        "id": "5f72fbcc-10ac-48ff-a2d2-02b229c38ce9",
                        "extension":
                        [
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/task-group",
                                "valueReference":
                                {
                                    "reference": "Group/0c59ba86-dd40-4fde-8179-6e0b91dc617b",
                                    "type": "Group",
                                    "display": "Payment Collection"
                                }
                            },
                            {
                                "url": "http://schemas.canvasmedical.com/fhir/extensions/task-permalink",
                                "valueString": "http://example.canvasmedical.com/permalinks/v1/VGFzazo4OTo3MA=="
                            }
                        ],
                        "status": "completed",
                        "priority": "urgent",
                        "description": "Ask patient for new insurance information.",
                        "for":
                        {
                            "reference": "Patient/cfd91cd3bd9046db81199aa8ee4afd7f",
                            "type": "Patient"
                        },
                        "authoredOn": "2023-09-22T14:00:00+00:00",
                        "lastModified": "2023-10-22T21:06:27.893521+00:00",
                        "requester":
                        {
                            "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                            "type": "Practitioner"
                        },
                        "owner":
                        {
                            "reference": "Practitioner/a02cbf2403e140f7bc9a355c6ed420f3",
                            "type": "Practitioner"
                        },
                        "intent": "unknown",
                        "restriction":
                        {
                            "period":
                            {
                                "end": "2023-09-23T14:00:00+00:00"
                            }
                        },
                        "note":
                        [
                            {
                                "authorReference":
                                {
                                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                                    "type": "Practitioner"
                                },
                                "time": "2023-09-22T14:00:00+00:00",
                                "text": "Please call patient to update insurance information."
                            }
                        ],
                        "input":
                        [
                            {
                                "type":
                                {
                                    "text": "label"
                                },
                                "valueString": "Urgent"
                            }
                        ]
                    }
                }
            ]
        }
        ```
  - **400**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "invalid",
              "details": {
                "text": "Bad request"
              }
            }
          ]
        }
        ```
  - **401**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "unknown",
              "details": {
                "text": "Authentication failed"
              }
            }
          ]
        }
        ```
  - **403**
        ```json
        {
          "resourceType": "OperationOutcome",
          "issue": [
            {
              "severity": "error",
              "code": "forbidden",
              "details": {
                "text": "Authorization failed"
              }
            }
          ]
        }
        ```
----- END PAGE https://docs.canvasmedical.com/api/task/


----- BEGIN PAGE https://docs.canvasmedical.com/api/terms-of-use/
This Developer Tools Agreement (this "Agreement") is between you and Canvas Medical, Inc. ("us", "we", and "our") and governs your rights to use and access Developer Tools for the purpose of developing, implementing, and releasing Connected Services. We may modify the terms of this Agreement at any time and will inform you of such changes in writing (including by email). For purposes of this Agreement, "you" and "your" means you as the user of the Developer Tools. If you are entering into this Agreement on behalf of an entity (such as a medical practice, company, firm, partnership, or any other organization type), you are binding such entity to this Agreement, and you represent that you have the actual authority to bind such entity to this Agreement, and references to "you" and "your" means such entity. Such entity will be legally and financially responsible for use of the Developer Tools by anyone affiliated with such entity, including employees, agents, and contractors. By using the Developer Tools, you accept all of the provisions of this Agreement and represent to us that you are at least 18 years of age and legally competent to enter into and agree to this Agreement. If you do not agree to this Agreement, you may not use the Developer Tools. THIS AGREEMENT INCLUDE (1) AN ARBITRATION PROVISION; (2) A WAIVER OF RIGHTS TO BRING A CLASS ACTION AGAINST US; AND (3) A RELEASE BY YOU OF ALL CLAIMS FOR DAMAGE AGAINST US THAT MAY ARISE OUT OF YOUR USE OF THE DEVELOPER TOOLS. BY USING ANY OF THE DEVELOPER TOOLS, YOU AGREE TO THESE PROVISIONS.
Definitions. "Application" means our software-as-a-service web-based primary care technology platform. "Developer Tools" means APIs and SDKs made available to you by us, as well as all accompanying and related source code, executables, documentation, and content. "Connected Services" means web or other software applications that you develop that use or interact with Developer Tools. "API" means an application programming interface developed and enabled by us that permits our customers and other third parties to access certain functionality provided by the Application. "SDK" means any software development kit related to the Application developed and enabled by us. Rights Granted. We grant you a non-exclusive, non-transferable, non-sublicensable, worldwide, revocable right and license during the term of this Agreement to use and make calls to Developer Tools to develop, implement, release, and support Connected Services that are capable of exchanging information with the Application. You agree we may limit, suspend, or revoke your access to or use of Developer Tools, and make modifications to or deprecate Developer Tools, at any time for any reason, with or without notice. Your Responsibilities. Connected Services do not in any way inherit government clearance or other regulatory approval solely by integrating with or incorporating the Application. You (not us) are solely responsible for ensuring Connected Services comply with all applicable laws, including those governing use in a health care setting. You agree you will comply with, and will ensure the Connected Services will comply with, policies and other restrictions we have implemented from time to time regarding use of Developer Tools. You agree to not and will not attempt to, under any circumstances, repackage or in any way resell the Application, in whole or in part, using the Developer Tools or any other method, in each case without our specific written permission. You agree not to share with any third party, and to securely store, any credentials we provide for you to use Developer Tools. Unless otherwise specifically agreed by us, you are solely responsible for the accuracy, completeness, quality, integrity, legality, reliability, and appropriateness of the Connected Services, as well as the security and integrity of data processed by the Connected Services. Without limiting the foregoing, you (not us) are responsible for (a) the technical installation and operation of Connected Services; creating and displaying information and content on, through or within Connected Services; (c) ensuring that Connected Services do not violate or infringe the another's intellectual property rights; (e) ensuring Connected Services do not contain or introduce malicious code into the Application, or any data processed by the Application; and (f) ensuring Connected Services are not designed to or utilized for the purpose of spamming any Application end users. Disclaimer of Warranties, Limitation of Liability. THE DEVELOPER TOOLS ARE PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS, WITHOUT ANY WARRANTIES OF ANY KIND TO THE FULLEST EXTENT PERMITTED BY LAW, AND WE EXPRESSLY DISCLAIM ANY AND ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. YOU AGREE THAT WE DO NOT WARRANT THAT THE DEVELOPER TOOLS WILL BE UNINTERRUPTED, TIMELY, SECURE, ERROR-FREE OR FREE FROM VIRUSES OR OTHER MALICIOUS SOFTWARE, AND NO INFORMATION OR ADVICE OBTAINED BY YOU FROM US WILL CREATE ANY WARRANTY NOT EXPRESSLY STATED IN THIS AGREEMENT. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY (WHETHER IN CONTRACT, TORT, NEGLIGENCE OR OTHERWISE) WILL WE, OR OUR AFFILIATES, OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, SUPPLIERS OR LICENSORS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOST PROFITS, LOST SALES OR BUSINESS, LOST DATA, BUSINESS INTERRUPTION, LOSS OF GOODWILL, OR FOR ANY TYPE OF INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, CONSEQUENTIAL OR PUNITIVE LOSS OR DAMAGES, OR ANY OTHER LOSS OR DAMAGES INCURRED BY YOU OR A THIRD PARTY IN CONNECTION WITH THIS AGREEMENT OR THE DEVELOPER TOOLS, REGARDLESS OF WHETHER WE WERE ADVISED OF THE POSSIBILITY OF OR COULD HAVE FORESEEN SUCH DAMAGES. NOTWITHSTANDING ANYTHING TO THE CONTRARY IN THIS AGREEMENT, OUR AGGREGATE LIABILITY TO YOU OR ANY THIRD PARTY ARISING OUT OF THIS AGREEMENT OR THE DEVELOPER TOOLS, WILL IN NO EVENT EXCEED ONE HUNDRED DOLLARS ($100.00). ANY CLAIM ARISING OUT OF OR RELATING TO THIS AGREEMENT MUST BE BROUGHT WITHIN ONE (1) YEAR OF THE FIRST EVENT OR OCCURRENCE GIVING RISE TO THE CLAIM. Indemnification. You agree to defend or settle, and to indemnify us and hold us harmless from, any claim brought by a third party against us arising from or related to any breach of an obligation, representation, warranty, covenant or other provision of this Agreement by you or any matter which you have agreed to be responsible for under this Agreement. Arbitration and Class Action Waiver. This Section includes an arbitration agreement and an agreement that all claims will be brought only in an individual capacity (and not as a Class Action or other representative proceeding). Please read it carefully. You may opt out of the arbitration agreement by following the opt out procedure described below. Informal Process First. You agree that in the event of any dispute between you and us, you will first contact us and make a good faith sustained effort to resolve the dispute before resorting to more formal means of resolution, including without limitation any court action. Arbitration Agreement. Under this Agreement, you agree that any dispute, claim, or controversy arising out of or relating to this Agreement your use of the Developer Tools, or relating in any way to the communications between you and us or any other user of Use will be finally resolved by confidential binding arbitration administered by Judicial Arbitration and Mediation Services ("JAMS") in San Francisco, California, or another forum mutually agreed upon by you and us. The arbitration will be conducted according to the JAMS Expedited Procedures for arbitration by a single arbitrator nominated jointly by you and us. If JAMS is not hearing consumer commercial disputes at the time, we may select another arbitral body at its sole discretion. The arbitrator's award will be binding and may be entered as a judgment in a court of competent jurisdiction. This clause shall not preclude us from seeking provisional remedies in aid of arbitration from a court of appropriate jurisdiction, or to seek injunctive relief in a court of competent jurisdiction to prevent the actual or threatened infringement, misappropriation, or violation of our copyrights, trademarks, trade secrets, or patents. This arbitration agreement does not (a) govern any Claim by us for infringement of our intellectual property or access to the Developer Tools that is unauthorized or exceeds authorization granted in this Agreement or (b) bar you from making use of applicable small claims court procedures in appropriate cases.
You agree that the U.S. Federal Arbitration Act governs the interpretation and enforcement of this provision, and that you and we are each waiving the right to a trial by jury or to participate in a Class Action. This arbitration provision will survive any termination of these this Agreement.
Class Action Waiver. Any Claim must be brought in the respective party's individual capacity, and not as a plaintiff or class member in any purported class, collective, representative, multiple plaintiff, or similar proceeding ("Class Action"). The parties waive any ability to maintain any Class Action in any forum. If the Claim is subject to arbitration, the arbitrator will not have authority to combine or aggregate similar claims or conduct any Class Action nor make an award to any person or entity not a party to the arbitration. Any claim that all or part of this Class Action Waiver is unenforceable, unconscionable, void, or voidable may be determined only by a court of competent jurisdiction and not by an arbitrator. The parties understand that any right to litigate in court, to have a judge or jury decide their case, or to be a party to a class or representative action, is waived, and that any claims must be decided individually, through arbitration.
If this Class Action waiver is found to be unenforceable, then the entirety of this Arbitration and Class Action Waiver Section, if otherwise effective, will be null and void. The arbitrator may award declaratory or injunctive relief only in favor of the individual party seeking relief and only to the extent necessary to provide relief warranted by that party's individual claim. If for any reason a claim proceeds in court rather than in arbitration, you and us each waive any right to a jury trial.
Ownership. Subject to the licenses and rights specified in this Agreement, nothing in this Agreement transfers or assigns to us any of your intellectual property rights in the Connected Services or your trademarks, logos, or other brand insignia nor does this Agreement transfer or assign to you any of our intellectual property rights in the Application and Developer Tools or our trademarks, logos, or other brand insignia. Support. This Agreement does not entitle you to receive from us any technical, customer, or sales support of the Application, Developer Tools, or Connected Services. You (not us) are solely responsible for providing technical assistance and other support related to the Connected Services. Miscellaneous. This Agreement constitutes the entire agreement between you and us regarding your use of the Developer Tools. If any term or provision of this Agreement is found to be invalid, illegal or otherwise unenforceable, such a finding will not affect the other terms or provisions of this Agreement, but such a term or provision will be deemed modified to the extent necessary to render such a term or provision enforceable, and the rights and obligations of you and us will be construed and enforced accordingly, preserving to the fullest permissible extent the intent and agreements set forth in this Agreement. Your obligations pursuant to this Agreement will survive termination of your use of the Developer Tools. The JAMS Rules and the laws of the State of California, excluding its conflicts of law rules, governs this Agreement and your use of the Developer Tools. Your use of the Developer Tools may also be subject to other local, state, national, or international laws.
----- END PAGE https://docs.canvasmedical.com/api/terms-of-use/


----- BEGIN PAGE https://docs.canvasmedical.com/guides/embedding-a-smart-on-fhir-application/
Canvas' FHIR API supports the SMART launch sequence, and the Canvas SDK allows you to embed html content within the Canvas EMR. The combination of these capabilities is a frictionless experience when embedding a SMART app into Canvas. This example will show you how to register a SMART app's credentials and create an application to launch it from within a patient's chart.
##  In this guide you will learn how to: 
  - Configure credentials for a public OAuth application.
  - Create an application to initiate the SMART launch sequence.
  - Use application launch context to help form the SMART launch URL parameters.
##  What is a SMART app? 
SMART on FHIR applications adhere to a standards-based approach to authentication, authorization, and data access with the goal of being portable across EMR installations and vendors. Because SMART apps limit themselves to standards based data, the logic can be agnostic to the EMR it is running against. Vendor to vendor, site to site, FHIR is FHIR, that's how it works, right?
##  Where can I get a SMART app? 
We've provided an example SMART app [here](https://github.com/canvas-medical/example-smart-on-fhir-app). You can fork it and customize, or just use ours as-is. We use GitHub pages to host it at `https://canvas-medical.github.io/example-smart-on-fhir-app/`. Please ensure the client id [listed in `launch.html`](https://github.com/canvas-medical/example-smart-on-fhir-app/blob/205b14ed8d4f4d9c57fd11a26f9a22c800f38c29/launch.html#L15) matches the client id for the credentials you configure in the next step.
##  Configuring credentials 
The first step to embedding a SMART application is to configure OAuth credentials for it to use. Navigate to `<YOUR_CANVAS_URL>/auth/applications/register/` and choose `Public` client type, `Authorization code` grant type, the `RSA` algorithm, and set the redirect uri for your SMART application.
![OAuth Configuration](/assets/images/guides/embedding-a-smart-app/SMART_OAuth.png)
##  Creating an application 
We encourage you to read our more comprehensive guide on [creating applications via the Canvas SDK](/guides/your-first-application/), but we can provide an abridged version here.
Using the [Canvas CLI](/sdk/canvas_cli/), create an application from a template using `canvas init application`. After providing a name, the Canvas CLI will create a directory with your application inside it.
    ```bash
    dev@canvas:plugins$ canvas init application
      [1/1] project_name (My Cool Application): My Smart App
    Project created in /Users/dev/src/plugins/my_smart_app
    dev@canvas:plugins$ tree my_smart_app/
    my_smart_app/
    ├── CANVAS_MANIFEST.json
    ├── README.md
    ├── applications
    │   ├── __init__.py
    │   └── my_application.py
    └── assets
        └── python-logo.png
    3 directories, 5 files
    ```
There are two files we'll want to visit for changes: `CANVAS_MANIFEST.json` and `applications/my_application.py`.
###  Configuring the manifest file 
In order to set the same-origin policy for the iframe our SMART app will be embedded into, we need to make sure the url where the SMART app is hosted is listed in the `url_permissions` section of the manifest, and the `ALLOW_SAME_ORIGIN` permission is requested.
    ```json
        "url_permissions": [
            {
                "url": "https://canvas-medical.github.io",
                "permissions": ["ALLOW_SAME_ORIGIN"]
            }
        ],
    ```
We also want to change the application scope from the default "global" setting to "patient specific":
    ```json
        "components": {
            "applications": [
                {
                    ...
                    "scope": "patient_specific",
                }
            ],
        },
    ```
###  Setting the SMART launch URL 
The SMART authorization dance begins with the SMART app's launch URL. The parameters present on this URL set the wheels in motion. The launch URL is loaded in an iframe, and javascript immediately reads the `iss` param in order to probe the FHIR API's CapabilityStatement for the EMR's Authorize endpoint, which the iframe is then redirected to, with its own load of URL parameters in tow.
We can set this initial URL and launch params in the `on_open` method found in `applications/my_application.py`. This is the code that is invoked when a user clicks the application's launch icon.
    ```python
    import json
    from base64 import b64encode
    from urllib.parse import urlencode
    from canvas_sdk.effects import Effect
    from canvas_sdk.effects.launch_modal import LaunchModalEffect
    from canvas_sdk.handlers.application import Application
    class MyApplication(Application):
        def on_open(self) -> Effect:
            launch_context = {
                "patient": self.context["patient"]["id"]
            }
            encoded_launch_context = b64encode(json.dumps(launch_context).encode()).decode()
            launch_params = {
                "iss": f"https://fumage-{self.environment['CUSTOMER_IDENTIFIER']}.canvasmedical.com",
                "launch": encoded_launch_context
            }
            encoded_launch_params = urlencode(launch_params)
            return LaunchModalEffect(
                url=f"https://canvas-medical.github.io/example-smart-on-fhir-app/launch.html?{encoded_launch_params}",
                target=LaunchModalEffect.TargetType.RIGHT_CHART_PANE,
            ).apply()
    ```
That's all the plugin work we need to do in order to create a launcher for the SMART application. Install the plugin into your Canvas instance, navigate to a patient's chart, and choose your application from the launcher.
##  Executing the launch sequence 
Upon launching your application, the SMART app will need the user to sign off on the access token it will receive to access the FHIR API on behalf of the logged in user.
![Authorize the token](/assets/images/guides/embedding-a-smart-app/SMART_Authorize.png)
The page you're seeing in the image is served by Canvas. This page is asking for the logged in user's consent to sending the SMART app a token which can access the FHIR API on the user's behalf. Clicking `Authorize` will redirect the iframe to the URL specified in the OAuth client's configuration with several params, most critically the API access token.
With the SMART app now in possession of a valid API access token, the application can function with access to all the data it is authorized to retrieve from the FHIR API. The example SMART app we've been working with simply shows the raw FHIR records retrieved for the patient.
![SMART app in action](/assets/images/guides/embedding-a-smart-app/SMART_App.png)
If you want to update the example SMART app to authorize additional data access from the FHIR API, you'll need to add those endpoints to the `scope` values in [launch.html](https://github.com/canvas-medical/example-smart-on-fhir-app/blob/main/launch.html), or wherever your authorize method is called:
    ```html
        <script>
            FHIR.oauth2.authorize({
                ...
                // The scopes that you request from the EHR. In this case we want to:
                scope: "patient/Patient.read patient/MedicationStatement.read patient/Goal.read patient/DocumentReference.read launch offline_access openid fhirUser",
                ...
            });
        </script>
    ```
For a more comprehensive list of available FHIR scopes, visit the [API docs](https://docs.canvasmedical.com/api/).
##  A more flexible alternative 
If you're looking to provide your users a more native experience without requiring the intricate authorization dance SMART prescribes, you're already pretty close just by going through the exercise above! While we created an embedded iframe of remote-hosted content, the Canvas SDK also allows you to [define HTTP endpoints](/sdk/handlers-simple-api-http/) which can also be the targets of the iframes. This allows your plugins to host [dynamically rendered HTML](/sdk/layout-effect/#custom-html-and-django-templates), CSS, Javascript, and more, with no external hosting required! You can take advantage of the built-in [session authentication](/sdk/handlers-simple-api-http/#session) for access control (no separate logins or authorizations for your users), and you have direct access to the EMR database through the Canvas SDK's [data module](/sdk/data/). [Caching](/sdk/caching/) and [websockets](/sdk/handlers-simple-api-websocket/) help you provide modern experiences, while the [effects module](/sdk/effects/) ensures you can write new data back into Canvas as needed.
The Canvas SDK allows you to deploy full web applications within the EMR, colocating your code with the data it needs to function, and without requiring any additional infrastructure. Want to explore further? Join us in our [developer community](https://github.com/canvas-medical/canvas-plugins/discussions) and say hello!
----- END PAGE https://docs.canvasmedical.com/guides/embedding-a-smart-on-fhir-application/


----- BEGIN PAGE https://docs.canvasmedical.com/guides/improve-hcc-coding-accuracy/
Different patients present unique challenges, and your tools should adapt to meet their specific needs.
Hierarchical condition category (HCC) coding is a critical component of value-based care, especially for organizations serving Medicare Advantage patients. Accurate risk adjustment ensures patients receive appropriate coverage while aligning reimbursement with the complexity of their care needs. However, navigating HCC coding can feel overwhelming with so many diagnoses to consider, guidelines to follow, and tools to use.
This guide will walk you through practical steps to use HCC codings in Canvas for more efficient and effective care delivery. You'll learn how to leverage our [HCC capture plugin](https://github.com/Medical-Software-Foundation/canvas/tree/main/extensions/hcc_capture) to do the following:
  - Create coding gaps from external data using the FHIR DetectedIssue endpoint
  - Surface coding gaps as actionable protocol cards
  - Address and resolve codings gaps seamlessly within the clinical workflow through streamlined commands.
  - Annotate ICD-10 codes that are mapped to HCC categories
By surfacing relevant data when and where it's needed, you can eliminate unnecessary steps, reduce cognitive load, and keep workflows aligned with patient needs.
##  Create Coding Gaps via FHIR Detected Issue 
The [DetectedIssue FHIR resource](/api/detectedissue)) can be used to surface an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, ineffective treatment frequency, procedure-condition conflict, gaps in care, etc.
A key use case is surfacing potential codings gaps that come from external sources.
The workflow within Canvas is centered around issues created with the `DetectedIssue.code` set to `CODINGGAP`. Although we are leveraging it in our R4 endpoint, `CODINGGAP` was introduced to the value set in R5, and can be used for surfacing conditions that may be present on historical claims but not yet diagnosed within the current year, suspect conditions, or condition data from external sources. The code should be structured as follows:
    ```json
        "code": {
            "coding": [
                {
                    "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode",
                    "code": "CODINGGAP"
                }
            ]
        },
    ```
The ICD-10 code can be added to `DetectedIssue.evidence` attribute.
Validated coding gaps (where `DetectedIssue.status` = `preliminary`) will appear in the patient summary if the coding gap commands are enabled in your environment (see more below).
##  Surface New Coding Gaps as Protocol Cards 
Clinical Documentation Improvement (CDI) staff often play a crucial role in reviewing potential coding gaps, especially those added via the API using external data.
There is no built in UI feature in Canvas that surfaces coding gaps that have yet to be reviewed for accuracy by staff members. Instead, We haven chosen to leverage plugins to allow for customization within your workflow for surfacing gaps in care. The example protocol below creates a [protocol card](/sdk/effect-protocol-cards/) when a new DetectedIssue is created for a coding gap with a `registered` status. It then recommends that a staff member validates the information before presenting it to a clinician in the summary.
The protocol will surface in each patient's chart and staff can also leverage the population page as a work list.
    ```python
    from canvas_sdk.protocols.clinical_quality_measure import ClinicalQualityMeasure
    from canvas_sdk.events import EventType
    from canvas_sdk.effects.protocol_card import ProtocolCard
    from canvas_sdk.v1.data.detected_issue import DetectedIssue
    class SurfaceNonvalidatedCodingGaps(ClinicalQualityMeasure):
        class Meta:
            title = "Validate Coding Gaps"
            identifiers = ["HCCCapturev1"]
            description = "Surfaces registered coding gaps within a protocol card with the recommendation to validate"
            information = "https://canvasmedical.com"
            references = ["Canvas Medical. https://docs.canvasmedical.com/guides/improve-hcc-coding-accuracy/"]
            authors = ["Canvas Medical"]
        RESPONDS_TO = [
            EventType.Name(EventType.DETECTED_ISSUE_CREATED),
            EventType.Name(EventType.DETECTED_ISSUE_UPDATED),
        ]
        def surface_non_validated_coding_gaps(self, patient, nonvalidated_coding_gaps):
            """
            Craft a protocol card with the list of coding gaps and return an add protocol card effect
            """
            card = ProtocolCard(
                patient_id=patient.id,
                key="hcccapturev1",
                title="Coding Gaps",
                narrative="These codings gaps have not been validated.",
                status=ProtocolCard.Status.DUE,
                feedback_enabled=False,
            )
            for coding_gap in nonvalidated_coding_gaps:
                coding_gap_title_strings = []
                for evidence in coding_gap.evidence.all():
                    coding_gap_title_strings.append(f"{evidence.display} ({evidence.code})")
                card.add_recommendation(
                    title="\n".join(coding_gap_title_strings),
                    button="Validate",
                    command="validateCodingGap",
                    context={"detected_issue_id": coding_gap.dbid},
                )
            return [card.apply()]
        def resolve_coding_gaps_protocol_card(self, patient):
            """
            Craft and return a remove protocol card effect
            """
            card = ProtocolCard(
                patient_id=patient.id,
                key="hcccapturev1",
                title="Coding Gaps",
                narrative="There are no non-validated coding gaps for this patient.",
                status=ProtocolCard.Status.SATISFIED,
                feedback_enabled=False,
            )
            return [card.apply()]
        def compute(self) -> list:
            """
            When a new detectedissue is created or updated, reevaluate (create/update/remove) a protocol card based on the associated evidence
            """
            detected_issue_from_the_event = DetectedIssue.objects.get(id=self.target)
            if detected_issue_from_the_event.code != "CODINGGAP":
                # This detected issue has no impact on the protocol card, so we
                # don't need to do any work.
                return []
            patient = detected_issue_from_the_event.patient
            all_of_that_patients_non_validated_detected_issues = patient.detected_issues.filter(status="registered", code="CODINGGAP")
            if all_of_that_patients_non_validated_detected_issues.count() > 0:
                return self.surface_non_validated_coding_gaps(patient, all_of_that_patients_non_validated_detected_issues)
            else:
                return self.resolve_coding_gaps_protocol_card(patient)
    ```
##  Use Coding Gap Commands to Update the Patient's Record 
The API can be leveraged to create coding gaps in various states. There are also 4 commands for clinicians and staff to manage coding gaps.
  - **Create Coding Gap** serves as a manual way to add coding gaps to the chart. Staff have the ability to create and validate in the same step.
  - **Validate Coding Gap** allows the care team (often CDI Reviewers) to review the external date and confirm that the gap should be surfaced to a clinician.
  - **Assess Coding Gap** allows clinicians to accept or refute the diagnose and choose the appropriate diagnosis to add to the visit.
  - **Defer Coding Gap** allows clinicians to acknowledge the gap and snooze it for a period of time so that they can return to it at a later date. This may be necessary if the patient is unable to provide enough detail or they run out of time during a visit. When recapture rate is an important metric, this allow reporting to reflect an action was taken.
##  Annotate ICD-10 Codes 
Adding an HCC tag as an annotation to ICD-10 is an easy way to increase awareness for clinicians. The example handlers below leverage a static list of ICD-codes. You could also reference a file contained within the plugin pacakge. Depending on which [HCC model](https://www.cms.gov/medicare/payment/medicare-advantage-rates-statistics/risk-adjustment) you follow, you can swap out the codes accordingly.
###  Adding "HCC" to Command Search Results 
The following handler leverages [command `POST_SEARCH` lifecycle events](/sdk/events/#command-lifecycle-events) and adds an `HCC` annotation to the associated ICD-10 codes within the results for the diagnose, past medical history, create coding gap, and assess coding gap commands.
    ```python
    import json
    from canvas_sdk.effects import Effect, EffectType
    from canvas_sdk.events import EventType
    from canvas_sdk.handlers import BaseHandler
    ICD_CODES = {
        "HCC": {"A0103", "A0104", "A0105", "A021", "A0222", "A0223", "A0224", "A065", "A072", "A202", "ADD_MORE_CODES..."}
    }
    class AnnotateSearchResults(BaseHandler):
        RESPONDS_TO = [
            EventType.Name(EventType.DIAGNOSE__DIAGNOSE__POST_SEARCH),
            EventType.Name(EventType.MEDICAL_HISTORY__PAST_MEDICAL_HISTORY__POST_SEARCH),
            EventType.Name(EventType.CREATE_CODING_GAP__DIAGNOSE__POST_SEARCH),
            EventType.Name(EventType.ASSESS_CODING_GAP__DIAGNOSE__POST_SEARCH),
        ]
        def compute(self):
            """
            Add HCC code annotation if the HCC code is found in the search results.
            """
            results = self.context.get("results")
            if results is None:
                return [Effect(type=EffectType.AUTOCOMPLETE_SEARCH_RESULTS, payload=json.dumps(None))]
            post_processed_results = []
            for result in self.context["results"]:
                for coding in result.get("extra", {}).get("coding", []):
                    if not coding.get("system") in ("http://hl7.org/fhir/sid/icd-10", "ICD-10"):
                        continue
                    if coding.get("code") in ICD_CODES["HCC"]:
                        if result.get("annotations") is None:
                            result["annotations"] = []
                        result["annotations"].append("HCC")
                        break
                post_processed_results.append(result)
            return [
                Effect(
                    type=EffectType.AUTOCOMPLETE_SEARCH_RESULTS,
                    payload=json.dumps(post_processed_results),
                )
            ]
    ```
###  Adding Annotations to Conditions and Detected Issues 
The following event/effect pairings can be leveraged to add annotations (such as the `HCC` tag) to conditions and detected issues in the patient summary as well as on claims using the handler code below.
  - `CLAIM__CONDITIONS` and `ANNOTATE_CLAIM_CONDITION_RESULTS`
  - `PATIENT_CHART__CONDITIONS` and `ANNOTATE_PATIENT_CHART_CONDITION_RESULTS`
  - `PATIENT_CHART__DETECTED_ISSUES` and `ANNOTATE_PATIENT_CHART_DETECTED_ISSUE_RESULTS`
    ```python
    import json
    from canvas_sdk.effects import Effect, EffectType
    from canvas_sdk.events import EventType
    from canvas_sdk.handlers import BaseHandler
    ICD_CODES = {
        "HCC": {
            "A0103", "A0104", "A0105", "A021", "A0222", "A0223", "A0224", "A065", "A072", "A202", "ADD_MORE_CODES...", 
        }
    }
    HCC = "HCC"
    class PatientChartConditionAnnotation(BaseHandler):
        """
        Annotate Conditions in the Patient Chart with an HCC tag
        """
        RESPONDS_TO = EventType.Name(EventType.PATIENT_CHART__CONDITIONS)
        def compute(self):
            """
            Annotate patient summary conditions if they match the provided set of HCC codes
            """
            hcc_codes = ICD_CODES[HCC]
            payload = {}
            for condition in self.context:
                icd10_code = next((coding.get("code") for coding in condition.get("codings", []) if coding.get("system") == "ICD10"), None)
                if not icd10_code:
                    continue
                if icd10_code in hcc_codes:
                    payload[condition["id"]] = [HCC]
            return [Effect(type=EffectType.ANNOTATE_PATIENT_CHART_CONDITION_RESULTS, payload=json.dumps(payload))]
    class ClaimConditionAnnotation(BaseHandler):
        """
        Annotate Conditions in the Claim modal with an HCC tag
        """
        RESPONDS_TO = [EventType.Name(EventType.CLAIM__CONDITIONS)]
        def compute(self):
            """
            Annotate claim conditions if they match the provided set of HCC codes
            """
            hcc_codes = ICD_CODES[HCC]
            payload = {}
            for condition in self.context:
                icd10_code = next((coding.get("code") for coding in condition.get("codings", []) if coding.get("system") == "ICD10"), None)
                if not icd10_code:
                    continue
                if icd10_code in hcc_codes:
                    payload[condition["id"]] = [HCC]
            return [Effect(type=EffectType.ANNOTATE_CLAIM_CONDITION_RESULTS, payload=json.dumps(payload))]
    class DetectedIssueAnnotation(BaseHandler):
        """
        Annotate Detected Issues in the Patient Chart with ICD-10 codes from evidence
        """
        RESPONDS_TO = EventType.Name(EventType.PATIENT_CHART__DETECTED_ISSUES)
        def compute(self):
            """
            Annotate patient summary detected issues with their ICD-10 code from evidence
            """
            payload = {}
            for detected_issue in self.context:
                # Get the first ICD-10 code from evidence if available
                evidence_code = None
                if detected_issue.get("evidence"):
                    for evidence in detected_issue["evidence"]:
                        if evidence.get("code"):
                            evidence_code = evidence["code"]
                            break
                if evidence_code:
                    payload[detected_issue["id"]] = [evidence_code]
            return [Effect(type=EffectType.ANNOTATE_PATIENT_CHART_DETECTED_ISSUE_RESULTS, payload=json.dumps(payload))]
    ```
##  Watch the Workflow in Action 
##  Conclusion 
By leveraging intuitive tools and streamlined workflows, you can simplify HCC coding and focus on delivering patient-centered care. This approach ensures accuracy, efficiency, and confidence in addressing risk adjustment challenges.
----- END PAGE https://docs.canvasmedical.com/guides/improve-hcc-coding-accuracy/


----- BEGIN PAGE https://docs.canvasmedical.com/guides/note-management-oauth/
This guide demonstrates how to build an external application that integrates with Canvas Medical using OAuth 2.0 authentication to manage notes (lock, sign, unlock, check-in, no-show).
##  Table of Contents 
  1. Overview
  2. OAuth 2.0 Setup
  3. Plugin Architecture
  4. Implementation Details
  5. API Endpoints
* * *
##  Overview 
[Note Management Plugin](https://github.com/canvas-medical/canvas-plugins/tree/main/example-plugins/note_management_app/note_management_app) demonstrates a complete integration pattern for external applications that need to:
  1. Authorize users via OAuth 2.0 Authorization Code Flow with PKCE
  2. Automatically refresh access tokens
  3. Call Canvas Simple API endpoints to perform note operations
###  Key Components 
  - **Application Handler** : Launches the web application in a new tab
  - **HTML Application** : Single-page application with OAuth flow and note management UI
  - **API Endpoints** : RESTful API for note operations (lock, sign, unlock, check-in, no-show)
* * *
##  OAuth 2.0 Setup 
###  Step 1: Create an OAuth Application in Canvas 
  1. Log in to your Canvas instance as an administrator
  2. Navigate to **Settings > Integrations > OAuth Applications**
  3. Click **Create Application**
  4. Configure the application: 
     - **Name** : `Note Management App` (or your preferred name)
     - **Client Type** : `Public` (for browser-based apps that cannot securely store client secrets)
     - **Authorization Grant Type** : `Authorization Code`
     - **Redirect URIs** : Add your application's redirect URI 
       - For production: `https://your-instance.canvasmedical.com/plugin-io/api/note_sign_api/app`
     - **Scopes** : Add `offline_access` (this allows the app to receive refresh tokens)
  5. **Save** the application
  6. Copy the **Client ID** \- you'll need this in the next step
###  Step 2. Install the Plugin 
    ```bash
    canvas install note_management_app/note_management_app --secret client_id=<YOUR_CLIENT_ID>
    ```
###  OAuth Flow Details 
####  Authorization Code Flow with PKCE 
This application implements the OAuth 2.0 Authorization Code Flow with Proof Key for Code Exchange (PKCE), which is the recommended flow for public clients (browser-based applications).
**Why PKCE?**
  - Protects against authorization code interception attacks
  - No client secret needed (suitable for public clients)
  - More secure for browser-based applications
**Flow Steps:**
  1. **Generate Code Verifier and Challenge**
         ```javascript
         // Generate a random string (43-128 characters)
         const codeVerifier = generateRandomString(128);
         // Create SHA-256 hash and base64url encode
         const codeChallenge = await generateCodeChallenge(codeVerifier);
         ```
  2. **Authorization Request**
         ```shell
         GET /auth/authorize/?
           response_type=code&
           client_id={CLIENT_ID}&
           redirect_uri={REDIRECT_URI}&
           scope=offline_access&
           code_challenge={CODE_CHALLENGE}&
           code_challenge_method=S256&
           launch=e30K
         ```
**Parameters:**
     - `response_type=code`: Request an authorization code
     - `client_id`: Your application's client ID
     - `redirect_uri`: Where Canvas will redirect after authorization
     - `scope=offline_access`: Request a refresh token for long-lived access
     - `code_challenge`: Base64url-encoded SHA-256 hash of the code verifier
     - `code_challenge_method=S256`: Indicates SHA-256 hashing
     - `launch=e30K`: Launch context (base64-encoded empty JSON object `{}`)
  3. **User Authorization**
     - User is redirected to Canvas login/authorization page
     - User authenticates and authorizes the application
     - Canvas redirects back to `redirect_uri` with an authorization code
  4. **Token Exchange**
         ```javascript
         POST /auth/token/
         Content-Type: application/x-www-form-urlencoded
         grant_type=authorization_code&
         code={AUTHORIZATION_CODE}&
         redirect_uri={REDIRECT_URI}&
         client_id={CLIENT_ID}&
         code_verifier={CODE_VERIFIER}
         ```
**Response:**
         ```json
         {
           "access_token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
           "refresh_token": "6KHq3fjkSWQ1vaBbF6WHG9...",
           "token_type": "Bearer",
           "expires_in": 36000,
           "scope": "offline_access"
         }
         ```
**Token Lifetimes:**
     - **Access Token** : Valid for 10 hours (36,000 seconds)
     - **Refresh Token** : Non-expiring, single-use token
  5. **Token Refresh**
         ```javascript
         POST /auth/token/
         Content-Type: application/x-www-form-urlencoded
         grant_type=refresh_token&
         refresh_token={REFRESH_TOKEN}&
         client_id={CLIENT_ID}&
         scope=offline_access
         ```
**Response:** Returns new access token and new refresh token
* * *
##  Plugin Architecture 
###  Directory Structure 
    ```shell
    note_sign_api/
    ├── handlers/
    │   ├── __init__.py
    │   ├── api.py              # API endpoints for note operations
    │   ├── application.py       # Application handler
    ├── templates/
    │   └── note_management_app.html  # HTML application
    ├── CANVAS_MANIFEST.json
    └── README.md
    ```
###  Component Overview 
####  1\. Application Handler (`handlers/application.py`) 
The Application handler launches the web application when triggered:
    ```python
    from canvas_sdk.effects import Effect
    from canvas_sdk.effects.launch_modal import LaunchModalEffect
    from canvas_sdk.handlers.application import Application
    class NoteManagementApplication(Application):
        """External note management application with OAuth integration."""
        def on_open(self) -> Effect:
            """Handle the application open event.
            Launches the note management application in a new window.
            """
            # Build the URL to the API endpoint that serves the HTML
            # Using relative path - Canvas will resolve to the correct instance
            app_url = "/plugin-io/api/note_sign_api/app"
            return LaunchModalEffect(
                url=app_url,
                target=LaunchModalEffect.TargetType.NEW_WINDOW,
            ).apply()
    ```
####  2\. App API Handler (`handlers/api.py` \- AppApi class) 
Serves the HTML application:
    ```python
    from http import HTTPStatus
    from canvas_sdk.effects import Effect
    from canvas_sdk.effects.note import Note
    from canvas_sdk.effects.simple_api import HTMLResponse, JSONResponse, Response
    from canvas_sdk.handlers.simple_api import Credentials, SimpleAPI, api
    from canvas_sdk.templates import render_to_string
    from canvas_sdk.v1.data import Note as NoteModel
    class AppApi(SimpleAPI):
        """API handler for serving the note management application."""
        PREFIX = ""
        def authenticate(self, credentials: Credentials) -> bool:
            """Allow access without authentication.
            The OAuth flow will handle authentication within the app.
            """
            return True
        @api.get("/app")
        def note_management_app(self) -> list[Response | Effect]:
            """Serve the note management application HTML."""
            # Get the Canvas instance URL from the request Host header
            host = self.request.headers.get("Host", "localhost:8000")
            # Determine protocol based on host
            if "localhost" in host or "127.0.0.1" in host:
                canvas_instance = f"http://{host}"
            else:
                canvas_instance = f"https://{host}"
            # Render the HTML template with context
            context = {"canvas_instance": canvas_instance}
            return [
                HTMLResponse(
                    render_to_string("templates/note_management_app.html", context),
                    status_code=HTTPStatus.OK,
                )
            ]
    ```
####  3\. Note API Handler (`handlers/api.py` \- NoteApi class) 
Provides RESTful API endpoints for note operations:
    ```python
    from http import HTTPStatus
    from canvas_sdk.effects import Effect
    from canvas_sdk.effects.note import Note
    from canvas_sdk.effects.simple_api import HTMLResponse, JSONResponse, Response
    from canvas_sdk.handlers.simple_api import Credentials, SimpleAPI, api
    from canvas_sdk.templates import render_to_string
    from canvas_sdk.v1.data import Note as NoteModel
    class NoteApi(SimpleAPI):
        """API handler for note-related operations."""
        PREFIX = "/notes"
        def authenticate(self, credentials: Credentials) -> bool:
            """Authenticate requests."""
            return self.event.actor.instance is not None
        @api.post("/<id>/lock")
        def lock_note(self) -> list[Response | Effect]:
            """Lock a note."""
            note_id = self.request.path_params["id"]
            try:
                note_instance = NoteModel.objects.get(id=note_id)
            except NoteModel.DoesNotExist:
                return [
                    JSONResponse(
                        {"error": "Note not found."},
                        status_code=404,
                    )
                ]
            note = Note(instance_id=note_instance.id)
            return [note.lock()]
    ```
* * *
##  Implementation Details 
####  Key JavaScript Functions 
#####  PKCE Implementation 
    ```javascript
    // Generate random string for code verifier
    function generateRandomString(length) {
        const charset = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~';
        let result = '';
        const randomValues = new Uint8Array(length);
        crypto.getRandomValues(randomValues);
        for (let i = 0; i < length; i++) {
            result += charset[randomValues[i] % charset.length];
        }
        return result;
    }
    // Generate code challenge from verifier
    async function generateCodeChallenge(codeVerifier) {
        const encoder = new TextEncoder();
        const data = encoder.encode(codeVerifier);
        const hash = await crypto.subtle.digest('SHA-256', data);
        const base64 = btoa(String.fromCharCode(...new Uint8Array(hash)));
        return base64.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
    }
    ```
#####  OAuth Initiation 
    ```javascript
    async function initiateOAuth() {
        // Generate PKCE values
        const codeVerifier = generateRandomString(128);
        const codeChallenge = await generateCodeChallenge(codeVerifier);
        // Store verifier for token exchange
        sessionStorage.setItem('code_verifier', codeVerifier);
        // Build authorization URL
        const authUrl = `${CANVAS_INSTANCE}/auth/authorize/?` +
            `response_type=code` +
            `&client_id=${encodeURIComponent(CLIENT_ID)}` +
            `&redirect_uri=${encodeURIComponent(REDIRECT_URI)}` +
            `&scope=${encodeURIComponent(SCOPES)}` +
            `&code_challenge=${codeChallenge}` +
            `&code_challenge_method=S256` +
            `&launch=${LAUNCH_CONTEXT}`;
        // Redirect to Canvas authorization
        window.location.href = authUrl;
    }
    ```
#####  Token Exchange 
    ```javascript
    async function handleAuthCallback() {
        const urlParams = new URLSearchParams(window.location.search);
        const code = urlParams.get('code');
        if (code) {
            const codeVerifier = sessionStorage.getItem('code_verifier');
            const response = await fetch(`${CANVAS_INSTANCE}/auth/token/`, {
                method: 'POST',
                headers: {
                    'Content-Type': 'application/x-www-form-urlencoded',
                },
                body: new URLSearchParams({
                    grant_type: 'authorization_code',
                    code: code,
                    redirect_uri: REDIRECT_URI,
                    client_id: CLIENT_ID,
                    code_verifier: codeVerifier
                })
            });
            const data = await response.json();
            saveTokens(data);
            // Clean up
            window.history.replaceState({}, document.title, window.location.pathname);
            sessionStorage.removeItem('code_verifier');
            updateUI();
        }
    }
    ```
#####  Token Storage and Refresh 
    ```javascript
    function saveTokens(tokenData) {
        localStorage.setItem(ACCESS_TOKEN_KEY, tokenData.access_token);
        localStorage.setItem(REFRESH_TOKEN_KEY, tokenData.refresh_token);
        // Calculate expiry time
        const expiryTime = Date.now() + (tokenData.expires_in * 1000);
        localStorage.setItem(TOKEN_EXPIRY_KEY, expiryTime.toString());
        // Schedule refresh 5 minutes before expiry
        scheduleTokenRefresh(tokenData.expires_in - 300);
    }
    async function refreshAccessToken() {
        const refreshToken = localStorage.getItem(REFRESH_TOKEN_KEY);
        const response = await fetch(`${CANVAS_INSTANCE}/auth/token/`, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/x-www-form-urlencoded',
            },
            body: new URLSearchParams({
                grant_type: 'refresh_token',
                refresh_token: refreshToken,
                client_id: CLIENT_ID
            })
        });
        const data = await response.json();
        saveTokens(data);
        showSuccess('Access token refreshed automatically');
    }
    ```
#####  API Calls 
    ```javascript
    async function performAction(action) {
        const noteId = document.getElementById('noteId').value.trim();
        const accessToken = localStorage.getItem(ACCESS_TOKEN_KEY);
        const actionMap = {
            'lock': '/lock',
            'sign': '/sign',
            'unlock': '/unlock',
            'lock_sign': '/lock_sign',
            'checkin': '/checkin',
            'noshow': '/noshow'
        };
        const endpoint = actionMap[action];
        const response = await fetch(
            `${CANVAS_INSTANCE}/plugins/note_sign_api/notes/${noteId}${endpoint}`,
            {
                method: 'POST',
                headers: {
                    'Authorization': `Bearer ${accessToken}`,
                    'Content-Type': 'application/json'
                }
            }
        );
        if (!response.ok) {
            // Handle errors, possibly refresh token if 401
            if (response.status === 401) {
                await refreshAccessToken();
            }
        }
    }
    ```
* * *
##  API Endpoints 
###  Base URL 
All plugin API endpoints are prefixed with:
    ```shell
    https://your-instance.canvasmedical.com/plugin-io/api/note_sign_api/
    ```
###  Available Endpoints 
####  1\. Serve Application 
    ```shell
    GET /app
    ```
**Description** : Serves the HTML application
* * *
####  2\. Lock Note 
    ```shell
    POST /notes/<note_id>/lock
    ```
**Description** : Locks a note to prevent further editing
* * *
####  3\. Sign Note 
    ```shell
    POST /notes/<note_id>/sign
    ```
**Description** : Signs a note (if signature is required)
* * *
####  4\. Lock and Sign Note 
    ```shell
    POST /notes/<note_id>/lock_sign
    ```
**Description** : Locks and signs a note in one operation
* * *
####  5\. Unlock Note 
    ```shell
    POST /notes/<note_id>/unlock
    ```
**Description** : Unlocks a previously locked or signed note
* * *
####  6\. Check In 
    ```shell
    POST /notes/<note_id>/checkin
    ```
**Description** : Marks an appointment as checked in
* * *
####  7\. No Show 
    ```shell
    POST /notes/<note_id>/noshow
    ```
**Description** : Marks an appointment as no-show
* * *
##  Security Considerations 
###  1\. Token Storage 
**Current Implementation** : Tokens are stored in `localStorage`
**Considerations** :
  - `localStorage` is vulnerable to XSS attacks
  - For production, consider using: 
    - HTTP-only cookies (requires backend support)
    - Session storage (cleared when tab closes)
    - Encrypted storage solutions
###  2\. PKCE Protection 
  - PKCE prevents authorization code interception attacks
  - Code verifier is stored in `sessionStorage` (temporary)
  - Code challenge is sent to authorization server
  - Server verifies verifier matches challenge during token exchange
###  3\. Token Refresh 
  - Refresh tokens are single-use (Canvas rotates them)
  - Access tokens are short-lived (10 hours)
  - Automatic refresh happens before expiry
  - Failed refresh triggers re-authentication
###  4\. API Authentication 
> **⚠️ Important** : The current implementation relies on the OAuth-authenticated user from Canvas. This is a simplified example for demonstration purposes.
**Current Implementation** :
    ```python
    from canvas_sdk.handlers.simple_api import Credentials
    def authenticate(self, credentials: Credentials) -> bool:
        return self.event.actor.instance is not None
    ```
This basic authentication check verifies that there is an authenticated Canvas user making the request.
**Production Recommendations** :
See the official documentation for supported authentication mechanisms: [Canvas SDK Authentication Guide](https://docs.canvasmedical.com/sdk/handlers-simple-api-http/#authentication)
* * *
##  Additional Resources 
  - [Canvas Customer Authentication Documentation](https://docs.canvasmedical.com/api/customer-authentication/)
  - [OAuth 2.0 Authorization Code Flow](https://oauth.net/2/grant-types/authorization-code/)
  - [PKCE RFC 7636](https://tools.ietf.org/html/rfc7636)
----- END PAGE https://docs.canvasmedical.com/guides/note-management-oauth/


----- BEGIN PAGE https://docs.canvasmedical.com/guides/staying-on-top-of-tasks/
Many Canvas users work in multiple systems. If you have a system that deals with tasks that are ultimately completed in Canvas, you'll want to manage the full task lifecycle from that external system. Using Canvas' [FHIR API](/api/) and the [Canvas SDK](/sdk/), you can have your system create tasks in Canvas, and get notified when your users complete them.
![](/assets/images/guides/staying-on-top-of-tasks/flow.png)
##  Creating Tasks with the FHIR API 
Your system can originate Tasks in Canvas using our FHIR [Task Create endpoint](/api/task/#create). The id of the task you create can be found in the `location` response header. It comes back as the FHIR Task Read URL, but you can parse the id from it. See the example below. Remember, this code is hitting the Canvas API from _your_ system, not from within Canvas.
    ```python
    import requests
    import json
    payload = json.dumps({
      "resourceType": "Task",
      "status": "requested",
      "intent": "unknown",
      "description": "Send a thank you card to the office admin team.",
      "requester": {
        "reference": "Practitioner/abc123"
      }
    })
    url = "https://fumage-api-test-clinic.canvasmedical.com/Task"
    headers = {
      'Content-Type': 'application/json',
      'Authorization': 'not-a-real-token'
    }
    response = requests.request("POST", url, headers=headers, data=payload)
    # find the id of the task we just created
    task_location = response.headers['location']  # http://fumage-api-test-clinic.canvasmedical.com/Task/b6426693-eb5b-4702-9f90-4728972c7f16
    task_id = task_location.split("/Task/")[1]  # b6426693-eb5b-4702-9f90-4728972c7f16
    ```
You can then take that task id and persist it in your application for tracking its status. While some choose to poll for status changes, a better way to keep track of the state of a task is by creating a webhook. We can do that with the Canvas SDK.
##  Creating a Task completion webhook with the Canvas SDK 
> **Info:** Webhook plugins are discussed in more detail in [Creating Webhooks with the Canvas SDK](/guides/creating-webhooks-with-the-canvas-sdk/). 
Implementing webhooks in a plugin gives you ultimate control over the payload and headers in your request. We use the python [requests](https://requests.readthedocs.io/en/latest/) library under the hood, so there's an extremely good chance anything you require for your request is supported.
In this example, we listen for either the `TASK_COMPLETED` or the `TASK_CLOSED` events, and send an HTTP POST with the id of the task that was either completed or closed, along with whether it was completed or closed. The target of the event is the id of the task, so the event comes with all the information we need here. You can substitute any of the Canvas SDK's supported [events](/sdk/events/) to extend this example to other record types.
    ```python
    from canvas_sdk.events import EventType
    from canvas_sdk.handlers.base import BaseHandler
    from canvas_sdk.utils import Http
    from logger import log
    class TaskResolutionWebhook(BaseHandler):
        RESPONDS_TO = [
            EventType.Name(EventType.TASK_COMPLETED),
            EventType.Name(EventType.TASK_CLOSED),
        ]
        def compute(self):
            task_disposition = 'closed'
            if self.event.type == EventType.TASK_COMPLETED:
                task_disposition = 'completed'
            url = "https://webhook.site/ee7aed78-b652-4d9e-b858-04465c409d15"
            payload = {
                "task_id": self.target,
                "disposition": task_disposition,
            }
            http = Http()
            response = http.post(url, json=payload)
            if response.ok:
                log.info("Successfully notified API of task update!")
            else:
                log.info("Notification unsuccessful. =[")
            return []
    ```
Once installed, the url you specified in the code will receive an HTTP POST request whenever a user marks a task as completed or closed. Your application can listen for those requests and update your internal status of that task.
----- END PAGE https://docs.canvasmedical.com/guides/staying-on-top-of-tasks/


----- BEGIN PAGE https://docs.canvasmedical.com/guides/submit-vitals-via-fhir/
Inside of the Canvas' [Vital Command](https://canvas-medical.help.usepylon.com/articles/9426091672-command-vitals) there are many vital signs supported to document.
![Protocol framework](/assets/images/vitals/vital-empty.png)
The Canvas [FHIR Observation Create](/api/observation/#create) endpoint supports writing some of the vital signs in the command. This guide will show you all the vitals that can be documented in the Create interaction.
* * *
##  What you'll learn 
In this guide, you will learn how to do the following:
  1. Create a vital panel via FHIR
  2. Submit various vital signs into the same panel via FHIR
  3. Perform a FHIR Observation Search to view the completed panel
* * *
###  1\. Setup and Authentication 
This guide will demonstrate many FHIR API calls into Canvas. Before we can make a FHIR request, we need to setup some imports, reusable variables, and authenticate into the instance we want to work with.
Here is your starting point:
    ```python
    import requests
    url = "https://fumage-example.canvasmedical.com/Observation"
    headers = {
        "accept": "application/json",
        "Authorization": "Bearer <token>",
        "content-type": "application/json"
    }
    ```
But there are two places above to update:
  1. The `url` will show `https://fumage-example.canvasmedical.com/Observation`. You will need to replace `example` with the name of the Canvas instance you are using.
  2. One of the `header` elements will be `'Authorization': 'Bearer <token>'`. You will need to create this `<token>` following our steps laid out in [Customer Authentication](/api/customer-authentication)
###  2\. Understanding our Observation Payload 
Before we start creating the vital panel and the associated vital signs, take some time to familiarize yourself with the [FHIR Observation Create](/api/observation/#create) endpoint. Each payload to create an observation requires `status`, `code`, and `subject`.
In this guide the `status` will always be `final` and the `subject` will always appear as:   
`"subject": { "reference": "Patient/$patient_id" }`.  
When completing these steps yourself, you will want to change the `{patient_id}` to match a patient in the instance you are using (e.g `"Patient/ee8672f3497e4a83937b9e71d0a704a5"`).
The `code` attribute is the real magic that tells Canvas which vital you are creating. The coding will always be a LOINC code.
Another thing to note is an optional `effectiveDateTime` attribute. This allows you to specify the time the vital was taken. But if omitted, it will default to the time of creation.
###  3\. Create a Vital Panel 
First we will need to create the panel object to be able to save all the individual vital signs to. The important attribute is the `code.coding[0][code]` being `85353-1` to represent a vital panel.
Here is the payload for how to create a Vital Panel (remember to set the patient_id and also update the effectiveDateTime):
    ```python
    import requests
    url = "https://fumage-example.canvasmedical.com/Observation"
    headers = {
        "accept": "application/json",
        "Authorization": "Bearer <token>",
        "content-type": "application/json"
    }
    patient_id = "<a patient ID from your instance>"
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "85353-1",
                    "display": "Vital Panel"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00"
    }
    response = requests.post(url, json=payload, headers=headers)
    ```
On a successful create, when the `response.status_code` equal 201. We can fetch the ID of the newly created observation in the `response.headers['location']` attribute. The value will always be in the format `{url}/{id}/_history/1`. We need to extract the `id` from the value.
However, if the request failed it will throw an error to see what went wrong. It will also display the Correlation ID that can be given to Customer Support for help with further debugging.
    ```python
    if response.status_code == 201:
        panel_id = response.headers['location'].replace(f"{url.replace('https', 'http')}/", '').replace('/_history/1', '')
    else:
        raise Exception(f"Failed to perform {response.url}. \n Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be a Data Import note placed on that patient's timeline based on the date passed in the `effectiveDateTime` attribute with an empty Vitals Command:
![Protocol framework](/assets/images/vitals/vital-panel-in-import-note.png)
###  4\. Creating Individual Vital Signs 
Now that we have created a Vital Panel, we will be able to use this panel_id when creating the individual vital signs to be associated with the same command by passing the `derivedFrom` attribute in the payload:
    ```python
    payload = {
        # ...
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ],
        # ...
    }
    ```
Now we are ready to create the following vital signs in the panel that are supported via FHIR Observation Create:
  - Height
  - Weight
  - Waist Circumference
  - Body Temperature
  - Blood Pressure
  - Pulse Rhythm
  - Pulse Rate
  - Respiration Rate
  - Oxygen Saturation
  - Notes
####  Add Height 
Height is denoted by the LOINC code `8302-2`. Since its value is numeric, we will be able to pass the value and units through the `valueQuantity` attribute. By default if no `valueQuantity.unit` is specified, it will default to using inches, but `cm` is also supported, it will just convert it to inches on the UI and when a Read/Search is performed.
Here is a payload to create a height of 69.0 inches:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "8302-2",
                    "display": "Height"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueQuantity": {
            "value": 69.0,
            "unit": "in",
        },
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Height observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be height of `69.0 in` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/height.png)
####  Add Weight 
Weight is denoted by the LOINC code `29463-7`. Since its value is numeric, we will be able to pass the value and units through the `valueQuantity` attribute. By default if no `valueQuantity.unit` is specified, it will default to using ounces, but `lb` or `kg` is also supported, it will just convert it to `oz` when a Read/Search is performed. The UI will display it in `lbs` and leftover `oz`.
Here is a payload to create a weight of 176.4 lbs:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "29463-7",
                    "display": "Weight"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueQuantity": {
            "value": 176.4,
            "unit": "lb",
        },
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Weight observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be weight of `176 lbs 6.4 oz` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/weight.png)
####  Add Waist Circumference 
Waist Circumference is denoted by the LOINC code `29463-7`. Since its value is numeric, we will be able to pass the value and units through the `valueQuantity` attribute. By default if no `valueQuantity.unit` is specified, it will default to using centimeters, but `in` is also supported, it will just convert it to `cm` on the UI or when a Read/Search is performed.
Here is a payload to create a waist circumference of `98.2 cm`:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "56086-2",
                    "display": "Waist Circumference"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueQuantity": {
            "value": 98.2,
            "unit": "cm",
        },
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Waist Circumference observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be waist circumference of `98.2 cm` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/waist-circumference.png)
####  Add Body Temperature 
Body Temperature is denoted by the LOINC code `8310-5`. Since its value is numeric, we will be able to pass the value and units through the `valueQuantity` attribute. The only unit accepted for body temperature is `°F` and if omitted it will be default.
Here is a payload to create a temperature of `98.4 °F`:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "8310-5",
                    "display": "Body Temperature"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueQuantity": {
            "value": 98.4,
            "unit": "°F",
        },
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Body Temperature observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be temperature of `98.4 °F` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/body-temperature.png)
####  Add Blood Pressure 
Blood Pressure is denoted by the LOINC code `85354-9`. In the Vital's command blood pressure is a string value that combines the systolic and diastolic components with a `/`. So the payload will pass the `valueString` component in order for the blood pressure to appear correctly in the Vitals Command.
Since blood pressure is made up of two values, the payload will also define a `component` attribute list to pass the systolic (LOINC code `8480-6`) and diastolic (LOINC code `8462-4`) values. These two values are numeric, so they will have the `valueQuantity` attributes where the unit will be `mmHg`
Here is a payload to create a Blood Pressure of `122/68`:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "85354-9",
                    "display": "Blood Pressure"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueString": "122/68",
        "component": [
            {
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "8480-6",
                            "display": "Systolic blood pressure"
                        }
                    ]
                },
                "valueQuantity": {
                    "value": 122,
                    "unit": "mmHg"
                }
            },
            {
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "8462-4",
                            "display": "Diastolic blood pressure"
                        }
                    ]
                },
                "valueQuantity": {
                    "value": 68,
                    "unit": "mmHg"
                }
            }
        ],
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Blood Pressure observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be blood pressure of `122/68` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/blood-pressure.png)
####  Add Pulse Rate 
Pulse Rate is denoted by the LOINC code `8867-4`. Since its value is numeric, we will be able to pass the value and units through the `valueQuantity` attribute. The only unit accepted for pulse rate is `bpm` and if omitted it will be default.
Here is a payload to create a pulse rate of `115 bpm`:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "8867-4",
                    "display": "Pulse"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueQuantity": {
            "value": 115,
            "unit": "bpm",
        },
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Pulse Rate observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be pulse rate of `115 bpm` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/pulse-rate.png)
####  Add Pulse Rhythm 
Pulse Rhythm is denoted by the LOINC code `8884-9`. Canvas accepts only three different string values for pulse rhythm: `Regular`, `Irregularly Irregular`, or `Regulary Irregular`. This value will be passed in the `valueString` attribute.
Here is a payload to create a pulse rhythm of `Regular`:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "8884-9",
                    "display": "Pulse Rhythm"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueString": "Regular",
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Pulse rhythm observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be pulse rhythm of `Regular` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/pulse-rhythm.png)
####  Add Respiration Rate 
Respiration Rate is denoted by the LOINC code `9279-1`. Since its value is numeric, we will be able to pass the value and units through the `valueQuantity` attribute. The only unit accepted for respiration rate is `bpm` and if omitted it will be default.
Here is a payload to create a respiration rate of `15 bpm`:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "9279-1",
                    "display": "Respiration Rate"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueQuantity": {
            "value": 15,
            "unit": "bpm",
        },
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Respiration Rate observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be respiration rate of `15 bpm` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/respiration-rate.png)
####  Add Oxygen Saturation 
Oxygen Saturation is denoted by either LOINC code `2708-6` or `59408-5`. Canvas saves the oxygen saturation with both codings. Since its value is numeric, we will be able to pass the value and units through the `valueQuantity` attribute. The only unit accepted for Oxygen Saturation is `%` and if omitted it will be default.
Here is a payload to create a Oxygen Saturation of `98%`:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "2708-6",
                    "display": "Oxygen Saturation Arterial"
                },
                {
                    "system": "http://loinc.org",
                    "code": "59408-5",
                    "display": "Oxygen Saturation"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueQuantity": {
            "value": 98,
            "unit": "%",
        },
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Oxygen Saturation observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now be Oxygen Saturation of `98%` added in that Vitals Command:
![Protocol framework](/assets/images/vitals/oxygen-saturation.png)
####  Add Notes 
Adding a Note is denoted by the LOINC code `80339-5`. Since this value is free text, a `valueString` attribute can be used.
Here is a payload to create an internal Note:
    ```python
    payload = {
        "resourceType": "Observation",
        "status": "final",
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "80339-5",
                    "display": "Note"
                }
            ]
        },
        "subject": {
            "reference": f"Patient/{patient_id}"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "valueString": "Last Blood sugar was 78",
        "derivedFrom": [
            {
                "reference": f"Observation/{panel_id}",
                "type": "Observation"
            }
        ]
    }
    response = requests.post(url, json=payload, headers=headers)
    if response.status_code == 201:
        print(f"Oxygen Saturation observation id = {response.headers['location'].replace(f'{url}/', '').replace('/_history/1', '')}")
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
Looking in the Canvas UI, there will now will be a Note added in that Vitals Command:
![Protocol framework](/assets/images/vitals/note.png)
###  5\. Perform FHIR Observation Read and Search 
A full Vital Panel has been completed! Let's now perform a FHIR Observation Read using the `panel_id` to see all the observation members of this panel now:
    ```python
    from pprint import pprint
    response = requests.get(f"{url}/{panel_id}", headers=headers)
    if response.status_code == 200:
        pprint(response.json())
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
The output will look like:
    ```json
    {
        "resourceType": "Observation",
        "id": "64ef9722-87c9-4b51-96d5-5812f15654d2",
        "status": "final",
        "category": [
            {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                        "code": "vital-signs",
                        "display": "Vital Signs"
                    }
                ]
            }
        ],
        "code": {
            "coding": [
                {
                    "system": "http://loinc.org",
                    "code": "85353-1",
                    "display": "Vital Signs Panel"
                }
            ]
        },
        "subject": {
            "reference": "Patient/b23295011ddf4df799976866c84d79d3",
            "type": "Patient"
        },
        "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
        "issued": "2024-04-19T18:13:03.574074+00:00",
        "dataAbsentReason": {
            "coding": [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                    "code": "not-performed",
                    "display": "Not Performed"
                }
            ]
        },
        "hasMember": [
            {
                "reference": "Observation/a21ee97f-dd35-4266-afaf-3e1b0a537668",
                "type": "Observation",
                "display": "Height"
            },
            {
                "reference": "Observation/c9898fa2-e78e-48b0-8c7b-7ab8c99f0d30",
                "type": "Observation",
                "display": "Weight"
            },
            {
                "reference": "Observation/a70a2979-d820-42e4-a0c6-cdbd80d7468f",
                "type": "Observation",
                "display": "Waist Circumference"
            },
            {
                "reference": "Observation/794c1f41-a564-4f4c-b56e-6ab5ee40ad0e",
                "type": "Observation",
                "display": "Body Temperature"
            },
            {
                "reference": "Observation/4fe8ba77-14aa-4d4a-b7eb-eaa0020a741f",
                "type": "Observation",
                "display": "Blood Pressure"
            },
            {
                "reference": "Observation/8a7c9a2b-3b06-4ede-bb98-620788cf2071",
                "type": "Observation",
                "display": "Pulse"
            },
            {
                "reference": "Observation/53a6e624-d7a6-4eef-8e05-9d98c889d820",
                "type": "Observation",
                "display": "Pulse Rhythm"
            },
            {
                "reference": "Observation/3ef9d6d0-68db-46ce-b30d-ca7081da14b7",
                "type": "Observation",
                "display": "Respiration Rate"
            },
            {
                "reference": "Observation/e08993a5-1d62-4bb2-ae00-c30bcd8e66bf",
                "type": "Observation",
                "display": "Oxygen Saturation Arterial"
            },
            {
                "reference": "Observation/49c4871d-ce6c-4281-86aa-27a8dd03ccf8",
                "type": "Observation",
                "display": "Note"
            }
        ]
    }
    ```
And finally let's perform a FHIR Observation Search to see all the vital signs that are for that patient using the derived from search parameter:
    ```python
    from pprint import pprint
    response = requests.get(f"{url}?patient=Patient/{patient_id}&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&derived-from=Observation/{panel_id}&_count=20", headers=headers)
    if response.status_code == 200:
        pprint(response.json())
    else:
        raise Exception(f"Failed to perform {response.url}. \n Fumage Correlation ID: {response.headers['fumage-correlation-id']} \n {response.text}")
    ```
The response will look like:
    ```json
    {
        "resourceType": "Bundle",
        "type": "searchset",
        "total": 10,
        "link": [
            {
                "relation": "self",
                "url": "/Observation?category=vital-signs&derived-from=Observation%2F64ef9722-87c9-4b51-96d5-5812f15654d2&patient=Patient%2Fb23295011ddf4df799976866c84d79d3&_count=50&_offset=0"
            },
            {
                "relation": "first",
                "url": "/Observation?category=vital-signs&derived-from=Observation%2F64ef9722-87c9-4b51-96d5-5812f15654d2&patient=Patient%2Fb23295011ddf4df799976866c84d79d3&_count=50&_offset=0"
            },
            {
                "relation": "last",
                "url": "/Observation?category=vital-signs&derived-from=Observation%2F64ef9722-87c9-4b51-96d5-5812f15654d2&patient=Patient%2Fb23295011ddf4df799976866c84d79d3&_count=50&_offset=0"
            }
        ],
        "entry": [
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "a21ee97f-dd35-4266-afaf-3e1b0a537668",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "8302-2",
                                "display": "Height"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:04.487846+00:00",
                    "valueQuantity": {
                        "value": 69.0,
                        "unit": "in",
                        "system": "http://unitsofmeasure.org",
                        "code": "[in_i]"
                    },
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "c9898fa2-e78e-48b0-8c7b-7ab8c99f0d30",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "29463-7",
                                "display": "Weight"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:05.094527+00:00",
                    "valueQuantity": {
                        "value": 176.4,
                        "unit": "lb",
                        "system": "http://unitsofmeasure.org",
                        "code": "[lb_av]"
                    },
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "a70a2979-d820-42e4-a0c6-cdbd80d7468f",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "56086-2",
                                "display": "Waist Circumference"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:05.741607+00:00",
                    "valueQuantity": {
                        "value": 98.2,
                        "unit": "cm",
                        "system": "http://unitsofmeasure.org",
                        "code": "cm"
                    },
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "794c1f41-a564-4f4c-b56e-6ab5ee40ad0e",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "8310-5",
                                "display": "Body Temperature"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:06.216429+00:00",
                    "valueQuantity": {
                        "value": 98.4,
                        "unit": "°F",
                        "system": "http://unitsofmeasure.org",
                        "code": "[degF]"
                    },
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "4fe8ba77-14aa-4d4a-b7eb-eaa0020a741f",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "85354-9",
                                "display": "Blood Pressure"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:06.801703+00:00",
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ],
                    "component": [
                        {
                            "code": {
                                "coding": [
                                    {
                                        "system": "http://loinc.org",
                                        "code": "8480-6",
                                        "display": "Systolic blood pressure"
                                    }
                                ]
                            },
                            "valueQuantity": {
                                "value": 122.0,
                                "unit": "mmHg",
                                "system": "http://unitsofmeasure.org",
                                "code": "mm[Hg]"
                            }
                        },
                        {
                            "code": {
                                "coding": [
                                    {
                                        "system": "http://loinc.org",
                                        "code": "8462-4",
                                        "display": "Diastolic blood pressure"
                                    }
                                ]
                            },
                            "valueQuantity": {
                                "value": 68.0,
                                "unit": "mmHg",
                                "system": "http://unitsofmeasure.org",
                                "code": "mm[Hg]"
                            }
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "8a7c9a2b-3b06-4ede-bb98-620788cf2071",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "8867-4",
                                "display": "Pulse"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:07.375137+00:00",
                    "valueQuantity": {
                        "value": 115.0,
                        "unit": "bpm",
                        "system": "http://unitsofmeasure.org",
                        "code": "/min"
                    },
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "53a6e624-d7a6-4eef-8e05-9d98c889d820",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "8884-9",
                                "display": "Pulse Rhythm"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:07.860791+00:00",
                    "valueString": "Regular",
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "3ef9d6d0-68db-46ce-b30d-ca7081da14b7",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "9279-1",
                                "display": "Respiration Rate"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:08.331239+00:00",
                    "valueQuantity": {
                        "value": 15.0,
                        "unit": "bpm",
                        "system": "http://unitsofmeasure.org",
                        "code": "/min"
                    },
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "e08993a5-1d62-4bb2-ae00-c30bcd8e66bf",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "2708-6",
                                "display": "Oxygen Saturation Arterial"
                            },
                            {
                                "system": "http://loinc.org",
                                "code": "59408-5",
                                "display": "Oxygen Saturation"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:08.847291+00:00",
                    "valueQuantity": {
                        "value": 98.0,
                        "unit": "%",
                        "system": "http://unitsofmeasure.org",
                        "code": "%"
                    },
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            },
            {
                "resource": {
                    "resourceType": "Observation",
                    "id": "49c4871d-ce6c-4281-86aa-27a8dd03ccf8",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                    "code": "vital-signs",
                                    "display": "Vital Signs"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "80339-5",
                                "display": "Note"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/b23295011ddf4df799976866c84d79d3",
                        "type": "Patient"
                    },
                    "effectiveDateTime": "2024-03-29T08:50:24.883809+00:00",
                    "issued": "2024-04-19T18:13:09.336889+00:00",
                    "valueString": "Last Blood sugar was 78",
                    "derivedFrom": [
                        {
                            "reference": "Observation/64ef9722-87c9-4b51-96d5-5812f15654d2",
                            "type": "Observation"
                        }
                    ]
                }
            }
        ]
    }
    ```
----- END PAGE https://docs.canvasmedical.com/guides/submit-vitals-via-fhir/


