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.
Practitioner create
Create Practitioner with provided fields and values.
Attributes
Unique Canvas identifier for this resource.
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.
Identifies the meaning of the extension
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
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.
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.
The reference string of the location in the format of "Location/95b9ac2d-e963-4d7a-b165-7901870f1663".
Type the reference refers to (e.g. “Location”).
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.
A base64-encoded file.
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.
Identifies the meaning of the extension.
The system url of the coding.
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.
The display name of the coding.
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
The system attribute specifies the namespace in which the identifier value is unique.
Practitioner’s NPI number. Its value must be a 10 digit number.
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.
The name associated with the practitioner.
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.
Practitioner’s last name.
Practitioner’s first name. Only one first name is allowed.
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.
Telecommunications form for contact point - what communications system is required to make use of the contact.
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.
Identifies the purpose for the contact point.
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(es) of the practitioner entered in Canvas. No default values will be set.
Defines the purpose of this address.
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
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.
The name of the city, town, suburb, village or other community or delivery center.
Two-letter state abbreviation of the address.
The 5-digit postal code of the address.
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.
The date on which the practitioner was born, formatted as YYYY-MM-DD.
Practitioner photo(s).
Uri where the data can be found.
Label to display in place of the data.
Practitioner license(s)
This component identifies the issuing authority of the Practitioner’s qualification (license).
The system attribute specifies the namespace in which the identifier value is unique.
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.
License coding object. This attribute has no effect.
This field has no effect. Provide “License” as value.
A component of the Practitioner’s license that defines validity period of the license with starting and the ending dates.
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
A component of the Practitioner’s license object that defines the license issuing authority short name.
The display text of the license’s short name.
Reference that defines the content of this object.
The issuing authority short name.
Responses
Canvas returns the created resource's id as a UUID within the
location header and a null response body.Errors
Practitioner read
Read a Practitioner resource
Path Parameters
Response Payload Attributes
Unique Canvas identifier for this resource.
Canvas supports specific FHIR extensions on this resource.
Identifies the meaning of the extension
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
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.
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.
The reference string of the location in the format of "Location/95b9ac2d-e963-4d7a-b165-7901870f1663".
Type the reference refers to (e.g. “Location”).
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.
Extension for backward-compatible URLs
Uri where the data can be found.
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.
Identifies the meaning of the extension.
The system url of the coding.
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.
The display name of the coding.
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
The system attribute specifies the namespace in which the identifier value is unique.
Practitioner’s NPI number. Its value must be a 10 digit number.
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.
The name associated with the practitioner.
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.
Practitioner’s last name.
Practitioner’s first name. Only one first name is allowed.
Practitioner contact point(s) (email / phone / fax).
The identifier (ID) of the telecom (contact point) record in Canvas.
Telecommunications form for contact point - what communications system is required to make use of the contact.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Identifies the purpose for the contact point.
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(es) of the practitioner entered in Canvas. No default values will be set.
The identifier (ID) of the address record in Canvas.
Defines the purpose of this address.
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
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.
The name of the city, town, suburb, village or other community or delivery center.
Two-letter state abbreviation of the address.
The 5-digit postal code of the address.
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.
The date on which the practitioner was born, formatted as YYYY-MM-DD.
Practitioner photo(s).
Uri where the data can be found.
Label to display in place of the data.
Practitioner license(s)
This component identifies the issuing authority of the Practitioner’s qualification (license).
The system attribute specifies the namespace in which the identifier value is unique.
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.
License coding object. This attribute has no effect.
This field has no effect. Provide “License” as value.
A component of the Practitioner’s license that defines validity period of the license with starting and the ending dates.
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
A component of the Practitioner’s license object that defines the license issuing authority short name.
The display text of the license’s short name.
Reference that defines the content of this object.
The issuing authority short name.
Responses
Errors
Practitioner update
Update Practitioner with provided fields and values.
Attributes
Unique Canvas identifier for this resource.
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.
Identifies the meaning of the extension
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
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.
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.
The reference string of the location in the format of "Location/95b9ac2d-e963-4d7a-b165-7901870f1663".
Type the reference refers to (e.g. “Location”).
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.
A base64-encoded file.
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.
Identifies the meaning of the extension.
The system url of the coding.
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.
The display name of the coding.
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
The system attribute specifies the namespace in which the identifier value is unique.
Practitioner’s NPI number. Its value must be a 10 digit number.
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.
The name associated with the practitioner.
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.
Practitioner’s last name.
Practitioner’s first name. Only one first name is allowed.
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.
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.
Telecommunications form for contact point - what communications system is required to make use of the contact.
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.
Identifies the purpose for the contact point.
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(es) of the practitioner entered in Canvas. No default values will be set.
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.
Defines the purpose of this address.
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
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.
The name of the city, town, suburb, village or other community or delivery center.
Two-letter state abbreviation of the address.
The 5-digit postal code of the address.
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.
The date on which the practitioner was born, formatted as YYYY-MM-DD.
Practitioner photo(s).
Uri where the data can be found.
Label to display in place of the data.
Practitioner license(s)
This component identifies the issuing authority of the Practitioner’s qualification (license).
The system attribute specifies the namespace in which the identifier value is unique.
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.
License coding object. This attribute has no effect.
This field has no effect. Provide “License” as value.
A component of the Practitioner’s license that defines validity period of the license with starting and the ending dates.
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
A component of the Practitioner’s license object that defines the license issuing authority short name.
The display text of the license’s short name.
Reference that defines the content of this object.
The issuing authority short name.
Responses
Canvas returns a
null response body.Errors
Practitioner search
Search for Practitioner resources
Query Parameters
A Canvas-issued unique identifier
By default, only schedulable practitioners are displayed. Passing this parameter as “true” will return both schedulable and non-schedulable practitioners.
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”).
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.
Practitioner user email.
Practitioner NPI number.
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
Unique Canvas identifier for this resource.
Canvas supports specific FHIR extensions on this resource.
Identifies the meaning of the extension
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
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.
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.
The reference string of the location in the format of "Location/95b9ac2d-e963-4d7a-b165-7901870f1663".
Type the reference refers to (e.g. “Location”).
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.
Extension for backward-compatible URLs
Uri where the data can be found.
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.
Identifies the meaning of the extension.
The system url of the coding.
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.
The display name of the coding.
A secondary identifier for the Practitioner. This is the NPI number of the Practitioner in Canvas.
The system attribute specifies the namespace in which the identifier value is unique.
Practitioner’s NPI number. Its value must be a 10 digit number.
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.
The name associated with the practitioner.
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.
Practitioner’s last name.
Practitioner’s first name. Only one first name is allowed.
Practitioner contact point(s) (email / phone / fax).
The identifier (ID) of the telecom (contact point) record in Canvas.
Telecommunications form for contact point - what communications system is required to make use of the contact.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Identifies the purpose for the contact point.
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(es) of the practitioner entered in Canvas. No default values will be set.
The identifier (ID) of the address record in Canvas.
Defines the purpose of this address.
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
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.
The name of the city, town, suburb, village or other community or delivery center.
Two-letter state abbreviation of the address.
The 5-digit postal code of the address.
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.
The date on which the practitioner was born, formatted as YYYY-MM-DD.
Practitioner photo(s).
Uri where the data can be found.
Label to display in place of the data.
Practitioner license(s)
This component identifies the issuing authority of the Practitioner’s qualification (license).
The system attribute specifies the namespace in which the identifier value is unique.
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.
License coding object. This attribute has no effect.
This field has no effect. Provide “License” as value.
A component of the Practitioner’s license that defines validity period of the license with starting and the ending dates.
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
Start date of the Practitioner’s license. Expected date format is YYYY-MM-DD (Example - “2020-01-01”)
A component of the Practitioner’s license object that defines the license issuing authority short name.
The display text of the license’s short name.
Reference that defines the content of this object.
The issuing authority short name.
Responses
Errors
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" } } ] }