Practitioner

A person who is directly or indirectly involved in the provisioning of healthcare.

https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitioner.html

To create a new staff member manually in the Canvas UI, see this Zendesk article.

Related guides:
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/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/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 zendesk article 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 [ ususal ] 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
object[json]

License coding object. This attribute has no effect.

Click to view child attributes
text
string

This field has no effect. Provide “License” as value.

Value Options Supported:
  • License
period
object[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

Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)

issuer
object[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
valueString
string

The issuing authority short name.

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/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/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.
Note: There is a temporary extension that will contain the presigned URL for the Attachment; this will be provided while we migrate to static URLs that will require bearer authentication to retrieve attachment files. Use this extension for backward-compatible URLs until the migration is completed.

Click to view child attributes
extension
json

Extension for backward-compatible URLs

url
string

Uri where the data can be found.

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 zendesk article 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 [ ususal ]

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

Practitioner’s last name.

given
array[string]

Practitioner’s first name. Only one first name is allowed.

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
object[json]

License coding object. This attribute has no effect.

Click to view child attributes
text
string

This field has no effect. Provide “License” as value.

Value Options Supported:
  • License
period
object[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

Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)

issuer
object[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
valueString
string

The issuing authority short name.

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/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/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 zendesk article 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 [ ususal ] 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
object[json]

License coding object. This attribute has no effect.

Click to view child attributes
text
string

This field has no effect. Provide “License” as value.

Value Options Supported:
  • License
period
object[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

Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)

issuer
object[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
valueString
string

The issuing authority short name.

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.

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.

npiNumber
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 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/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/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.
Note: There is a temporary extension that will contain the presigned URL for the Attachment; this will be provided while we migrate to static URLs that will require bearer authentication to retrieve attachment files. Use this extension for backward-compatible URLs until the migration is completed.

Click to view child attributes
extension
json

Extension for backward-compatible URLs

url
string

Uri where the data can be found.

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 zendesk article 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 [ ususal ]

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

Practitioner’s last name.

given
array[string]

Practitioner’s first name. Only one first name is allowed.

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
object[json]

License coding object. This attribute has no effect.

Click to view child attributes
text
string

This field has no effect. Provide “License” as value.

Value Options Supported:
  • License
period
object[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

Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)

issuer
object[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
valueString
string

The issuing authority short name.

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 --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"
                        }
                    ]
                }
            }
        ]
    }
    '
    
  • 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"
                        }
                    ]
                }
            }
        ]
    }
    
    response = requests.post(url, json=payload, headers=headers)
    
    print(response.text)
    
  • null
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "invalid",
          "details": {
            "text": "Bad request"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "unknown",
          "details": {
            "text": "Authentication failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "forbidden",
          "details": {
            "text": "Authorization failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "not-supported",
          "details": {
            "text": "Operation is not supported"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "business-rule",
          "details": {
            "text": "Unprocessable entity"
          }
        }
      ]
    }
    
  • curl --request GET \
         --url 'https://fumage-example.canvasmedical.com/Practitioner/<id>' \
         --header 'Authorization: Bearer <token>' \
         --header 'accept: application/json'
    
  • 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)
    
  • {
        "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": {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/deprecated-url",
                            "valueUri": "https://canvas-client-media.s3.amazonaws.com/local/signature-cdfkizrj.pdf?AWSAccessKeyId=AKIA5KJ2QWTAU572JXPZ&Signature=ljyujvD4fkgOG7b3SxlIokdDIlQ%3D&Expires=1703596102"
                        }
                    ],
                    "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"
                        }
                    ]
                }
            }
        ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "unknown",
          "details": {
            "text": "Authentication failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "forbidden",
          "details": {
            "text": "Authorization failed"
          }
        }
      ]
    }
    
  • {
        "resourceType": "OperationOutcome",
        "issue": [
            {
                "severity": "error",
                "code": "not-found",
                "details": {
                    "text": "Unknown Practitioner resource '7d1ce256fcd7408193b0459650937a07'"
                }
            }
        ]
    }
    
    
  • 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",
                "extension": [
                    {
                        "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"
                        }
                    ]
                }
            }
        ]
    }
    '
    
  • 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"
                }
            },
            {
                "extension": [
                    {
                        "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/practitioner-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",
                "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"
                        }
                    ]
                }
            }
        ]
    }
    
    response = requests.put(url, json=payload, headers=headers)
    
    print(response.text)
    
  • null
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "invalid",
          "details": {
            "text": "Bad request"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "unknown",
          "details": {
            "text": "Authentication failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "forbidden",
          "details": {
            "text": "Authorization failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "not-found",
          "details": {
            "text": "Unknown  resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "not-supported",
          "details": {
            "text": "Operation is not supported"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "conflict",
          "details": {
            "text": "Resource updated since If-Unmodified-Since date"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "business-rule",
          "details": {
            "text": "Unprocessable entity"
          }
        }
      ]
    }
    
  • curl --request GET \
         --url 'https://fumage-example.canvasmedical.com/Practitioner?name=Samantha' \
         --header 'Authorization: Bearer <token>' \
         --header 'accept: application/json'
    
  • 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)
    
  • {
        "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": {
                    "extension": [
                        {
                            "url": "http://schemas.canvasmedical.com/fhir/extensions/deprecated-url",
                            "valueUri": "https://canvas-client-media.s3.amazonaws.com/local/signature-cdfkizrj.pdf?AWSAccessKeyId=AKIA5KJ2QWTAU572JXPZ&Signature=ljyujvD4fkgOG7b3SxlIokdDIlQ%3D&Expires=1703596102"
                        }
                    ],
                    "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"
                        }
                    ]
                }
            }
        ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "invalid",
          "details": {
            "text": "Bad request"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "unknown",
          "details": {
            "text": "Authentication failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "forbidden",
          "details": {
            "text": "Authorization failed"
          }
        }
      ]
    }