Beta

Update

PUT

/patients/v1/:id/:version

PUT

1 import datetime
2 import uuid
3 
4 from candid import CandidApiClient
5 from candid.resources.pre_encounter.resources.common import (
6     AdditionalPayerInformation,
7     Address,
8     AddressUse,
9     CanonicalNonInsurancePayerAssociation,
10     ContactPoint,
11     ContactPointUse,
12     DisabilityStatus,
13     Ethnicity,
14     ExternalIdentifier,
15     ExternalProvider,
16     ExternalProviderType,
17     Gender,
18     HumanName,
19     NameUse,
20     Period,
21     Race,
22     Relationship,
23     Sex,
24     SexualOrientation,
25 )
26 from candid.resources.pre_encounter.resources.patients.resources.v_1 import (
27     Authorization,
28     AuthorizationUnit,
29     Contact,
30     DoNotInvoiceReason,
31     ExternalProvenance,
32     FilingOrder,
33     Guarantor,
34     MaritalStatus,
35     MutablePatient,
36     Referral,
37 )
38 
39 client = CandidApiClient(
40     client_id="YOUR_CLIENT_ID",
41     client_secret="YOUR_CLIENT_SECRET",
42 )
43 client.pre_encounter.patients.v_1.update(
44     id="string",
45     version="string",
46     request=MutablePatient(
47         name=HumanName(
48             family="string",
49             given=["string"],
50             use=NameUse.USUAL,
51             period=Period(),
52         ),
53         other_names=[
54             HumanName(
55                 family="string",
56                 given=["string"],
57                 use=NameUse.USUAL,
58                 period=Period(),
59             )
60         ],
61         other_identifiers=[
62             ExternalIdentifier(
63                 value="string",
64                 system="string",
65             )
66         ],
67         gender=Gender.MAN,
68         birth_date=datetime.date.fromisoformat(
69             "2023-01-15",
70         ),
71         social_security_number="string",
72         biological_sex=Sex.FEMALE,
73         sexual_orientation=SexualOrientation.HETEROSEXUAL,
74         race=Race.AMERICAN_INDIAN_OR_ALASKA_NATIVE,
75         ethnicity=Ethnicity.HISPANIC_OR_LATINO,
76         disability_status=DisabilityStatus.DISABLED,
77         marital_status=MaritalStatus.ANNULLED,
78         deceased=datetime.datetime.fromisoformat(
79             "2024-01-15 09:30:00+00:00",
80         ),
81         multiple_birth=1,
82         primary_address=Address(
83             use=AddressUse.HOME,
84             line=["string"],
85             city="string",
86             state="string",
87             postal_code="string",
88             country="string",
89             period=Period(),
90         ),
91         other_addresses=[
92             Address(
93                 use=AddressUse.HOME,
94                 line=["string"],
95                 city="string",
96                 state="string",
97                 postal_code="string",
98                 country="string",
99                 period=Period(),
100             )
101         ],
102         primary_telecom=ContactPoint(
103             value="string",
104             use=ContactPointUse.HOME,
105         ),
106         other_telecoms=[
107             ContactPoint(
108                 value="string",
109                 use=ContactPointUse.HOME,
110             )
111         ],
112         email="string",
113         electronic_communication_opt_in=True,
114         photo="string",
115         language="string",
116         external_provenance=ExternalProvenance(
117             external_id="string",
118             system_name="string",
119         ),
120         contacts=[
121             Contact(
122                 relationship=[Relationship.SELF],
123                 name=HumanName(
124                     family="string",
125                     given=["string"],
126                     use=NameUse.USUAL,
127                     period=Period(),
128                 ),
129                 telecoms=[
130                     ContactPoint(
131                         value="string",
132                         use=ContactPointUse.HOME,
133                     )
134                 ],
135                 addresses=[
136                     Address(
137                         use=AddressUse.HOME,
138                         line=["string"],
139                         city="string",
140                         state="string",
141                         postal_code="string",
142                         country="string",
143                         period=Period(),
144                     )
145                 ],
146                 period=Period(),
147                 hipaa_authorization=True,
148             )
149         ],
150         general_practitioners=[
151             ExternalProvider(
152                 name=HumanName(
153                     family="string",
154                     given=["string"],
155                     use=NameUse.USUAL,
156                     period=Period(),
157                 ),
158                 type=ExternalProviderType.PRIMARY,
159                 npi="string",
160                 telecoms=[
161                     ContactPoint(
162                         value="string",
163                         use=ContactPointUse.HOME,
164                     )
165                 ],
166                 addresses=[],
167                 period=Period(),
168                 canonical_id="string",
169                 fax="string",
170             )
171         ],
172         filing_order=FilingOrder(
173             coverages=[
174                 uuid.UUID(
175                     "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
176                 )
177             ],
178         ),
179         non_insurance_payers=["string"],
180         non_insurance_payer_associations=[
181             CanonicalNonInsurancePayerAssociation(
182                 id="string",
183             )
184         ],
185         guarantor=Guarantor(
186             name=HumanName(
187                 family="string",
188                 given=["string"],
189                 use=NameUse.USUAL,
190                 period=Period(),
191             ),
192             telecom=ContactPoint(
193                 value="string",
194                 use=ContactPointUse.HOME,
195             ),
196             email="string",
197             birth_date=datetime.date.fromisoformat(
198                 "2023-01-15",
199             ),
200             address=Address(
201                 use=AddressUse.HOME,
202                 line=["string"],
203                 city="string",
204                 state="string",
205                 postal_code="string",
206                 country="string",
207                 period=Period(),
208             ),
209         ),
210         self_pay=True,
211         authorizations=[
212             Authorization(
213                 payer_id="string",
214                 payer_name="string",
215                 additional_payer_information=AdditionalPayerInformation(),
216                 authorization_number="string",
217                 cpt_code="string",
218                 units=AuthorizationUnit.VISIT,
219                 quantity=1,
220                 period=Period(),
221                 notes="string",
222             )
223         ],
224         referrals=[
225             Referral(
226                 provider=ExternalProvider(
227                     name=HumanName(
228                         family="string",
229                         given=["string"],
230                         use=NameUse.USUAL,
231                         period=Period(),
232                     ),
233                     type=ExternalProviderType.PRIMARY,
234                     npi="string",
235                     telecoms=[
236                         ContactPoint(
237                             value="string",
238                             use=ContactPointUse.HOME,
239                         )
240                     ],
241                     addresses=[],
242                     period=Period(),
243                     canonical_id="string",
244                     fax="string",
245                 ),
246                 referral_number="string",
247             )
248         ],
249         primary_service_facility_id="string",
250         do_not_invoice_reason=DoNotInvoiceReason.BANKRUPTCY,
251         note_ids=["string"],
252         tag_ids=["string"],
253     ),
254 )

Play

200Updated

1 {
2   "biological_sex": "FEMALE",
3   "birth_date": "2023-01-01",
4   "contacts": [
5     {
6       "relationship": [
7         "SELF"
8       ],
9       "name": {
10         "family": "string",
11         "given": [
12           "string"
13         ],
14         "use": "USUAL",
15         "period": {
16           "start": "2023-01-01",
17           "end": "2023-01-01"
18         }
19       },
20       "telecoms": [
21         {
22           "value": "string",
23           "use": "HOME",
24           "period": {
25             "start": "2023-01-01",
26             "end": "2023-01-01"
27           }
28         }
29       ],
30       "addresses": [
31         {
32           "use": "HOME",
33           "line": [
34             "string"
35           ],
36           "city": "string",
37           "state": "string",
38           "postal_code": "string",
39           "country": "string",
40           "period": {
41             "start": "2023-01-01",
42             "end": "2023-01-01"
43           }
44         }
45       ],
46       "period": {
47         "start": "2023-01-01",
48         "end": "2023-01-01"
49       },
50       "hipaa_authorization": true
51     }
52   ],
53   "deactivated": true,
54   "filing_order": {
55     "coverages": [
56       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
57     ]
58   },
59   "general_practitioners": [
60     {
61       "name": {
62         "family": "string",
63         "given": [
64           "string"
65         ],
66         "use": "USUAL",
67         "period": {
68           "start": "2023-01-01",
69           "end": "2023-01-01"
70         }
71       },
72       "telecoms": [
73         {
74           "value": "string",
75           "use": "HOME",
76           "period": {
77             "start": "2023-01-01",
78             "end": "2023-01-01"
79           }
80         }
81       ],
82       "type": "PRIMARY",
83       "npi": "string",
84       "addresses": [
85         {
86           "use": "HOME",
87           "line": [
88             "string"
89           ],
90           "city": "string",
91           "state": "string",
92           "postal_code": "string",
93           "country": "string",
94           "period": {
95             "start": "2023-01-01",
96             "end": "2023-01-01"
97           }
98         }
99       ],
100       "period": {
101         "start": "2023-01-01",
102         "end": "2023-01-01"
103       },
104       "canonical_id": "string",
105       "fax": "string"
106     }
107   ],
108   "id": "string",
109   "mrn": "string",
110   "name": {
111     "family": "string",
112     "given": [
113       "string"
114     ],
115     "use": "USUAL",
116     "period": {
117       "start": "2023-01-01",
118       "end": "2023-01-01"
119     }
120   },
121   "organization_id": "string",
122   "other_addresses": [
123     {
124       "use": "HOME",
125       "line": [
126         "string"
127       ],
128       "city": "string",
129       "state": "string",
130       "postal_code": "string",
131       "country": "string",
132       "period": {
133         "start": "2023-01-01",
134         "end": "2023-01-01"
135       }
136     }
137   ],
138   "other_names": [
139     {
140       "family": "string",
141       "given": [
142         "string"
143       ],
144       "use": "USUAL",
145       "period": {
146         "start": "2023-01-01",
147         "end": "2023-01-01"
148       }
149     }
150   ],
151   "other_telecoms": [
152     {
153       "value": "string",
154       "use": "HOME",
155       "period": {
156         "start": "2023-01-01",
157         "end": "2023-01-01"
158       }
159     }
160   ],
161   "primary_address": {
162     "use": "HOME",
163     "line": [
164       "string"
165     ],
166     "city": "string",
167     "state": "string",
168     "postal_code": "string",
169     "country": "string",
170     "period": {
171       "start": "2023-01-01",
172       "end": "2023-01-01"
173     }
174   },
175   "primary_telecom": {
176     "value": "string",
177     "use": "HOME",
178     "period": {
179       "start": "2023-01-01",
180       "end": "2023-01-01"
181     }
182   },
183   "updated_at": "2023-01-01T00:00:00Z",
184   "updating_user_id": "string",
185   "version": 0,
186   "authorizations": [
187     {
188       "payer_id": "string",
189       "payer_name": "string",
190       "authorization_number": "string",
191       "cpt_code": "string",
192       "units": "VISIT",
193       "additional_payer_information": {
194         "availity_eligibility_id": "string",
195         "availity_payer_id": "string",
196         "availity_payer_name": "string",
197         "availity_remittance_payer_id": "string"
198       },
199       "quantity": 0,
200       "period": {
201         "start": "2023-01-01",
202         "end": "2023-01-01"
203       },
204       "notes": "string"
205     }
206   ],
207   "deceased": "2023-01-01T00:00:00Z",
208   "disability_status": "DISABLED",
209   "do_not_invoice_reason": "BANKRUPTCY",
210   "electronic_communication_opt_in": true,
211   "email": "string",
212   "ethnicity": "HISPANIC_OR_LATINO",
213   "external_provenance": {
214     "external_id": "string",
215     "system_name": "string"
216   },
217   "gender": "MAN",
218   "guarantor": {
219     "name": {
220       "family": "string",
221       "given": [
222         "string"
223       ],
224       "use": "USUAL",
225       "period": {
226         "start": "2023-01-01",
227         "end": "2023-01-01"
228       }
229     },
230     "birth_date": "2023-01-01",
231     "address": {
232       "use": "HOME",
233       "line": [
234         "string"
235       ],
236       "city": "string",
237       "state": "string",
238       "postal_code": "string",
239       "country": "string",
240       "period": {
241         "start": "2023-01-01",
242         "end": "2023-01-01"
243       }
244     },
245     "telecom": {
246       "value": "string",
247       "use": "HOME",
248       "period": {
249         "start": "2023-01-01",
250         "end": "2023-01-01"
251       }
252     },
253     "email": "string"
254   },
255   "language": "string",
256   "marital_status": "ANNULLED",
257   "multiple_birth": 0,
258   "non_insurance_payer_associations": [
259     {
260       "id": "string",
261       "member_id": "string",
262       "clinical_trial_info": [
263         {
264           "id": "string",
265           "clinical_trial_arm": "string",
266           "period": {
267             "start": "2023-01-01",
268             "end": "2023-01-01"
269           }
270         }
271       ]
272     }
273   ],
274   "note_ids": [
275     "string"
276   ],
277   "other_identifiers": [
278     {
279       "value": "string",
280       "system": "string",
281       "period": {
282         "start": "2023-01-01",
283         "end": "2023-01-01"
284       }
285     }
286   ],
287   "photo": "string",
288   "primary_service_facility_id": "string",
289   "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
290   "referrals": [
291     {
292       "provider": {
293         "name": {
294           "family": "string",
295           "given": [
296             "string"
297           ],
298           "use": "USUAL",
299           "period": {
300             "start": "2023-01-01",
301             "end": "2023-01-01"
302           }
303         },
304         "telecoms": [
305           {
306             "value": "string",
307             "use": "HOME",
308             "period": {
309               "start": "2023-01-01",
310               "end": "2023-01-01"
311             }
312           }
313         ],
314         "type": "PRIMARY",
315         "npi": "string",
316         "addresses": [
317           {
318             "use": "HOME",
319             "line": [
320               "string"
321             ],
322             "city": "string",
323             "state": "string",
324             "postal_code": "string",
325             "country": "string",
326             "period": {
327               "start": "2023-01-01",
328               "end": "2023-01-01"
329             }
330           }
331         ],
332         "period": {
333           "start": "2023-01-01",
334           "end": "2023-01-01"
335         },
336         "canonical_id": "string",
337         "fax": "string"
338       },
339       "referral_number": "string",
340       "period": {
341         "start": "2023-01-01",
342         "end": "2023-01-01"
343       },
344       "notes": "string"
345     }
346   ],
347   "self_pay": true,
348   "sexual_orientation": "HETEROSEXUAL",
349   "social_security_number": "string",
350   "tag_ids": [
351     "string"
352   ],
353   "non_insurance_payers": [
354     "string"
355   ]
356 }

Updates a patient. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.

Path parameters

idstringRequired

The unique identifier for a Patient

versionstringRequired

Request

This endpoint expects an object.

nameobjectRequired

other_nameslist of objectsRequired

Other names for the patient.

birth_datedateRequired

biological_sexenumRequired

The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html

Allowed values:

primary_addressobjectRequired

The primary address for the patient.

other_addresseslist of objectsRequired

Other addresses for the patient.

primary_telecomobjectRequired

The primary phone number for the patient.

other_telecomslist of objectsRequired

Other phone numbers for the patient.

contactslist of objectsRequired

Contacts for the patient.

general_practitionerslist of objectsRequired

filing_orderobjectRequired

The patient’s active coverages, in order of primary, secondary, etc.

other_identifierslist of objectsOptional

Other identifiers for the patient.

genderenumOptional

social_security_numberstringOptional

sexual_orientationenumOptional

The sexual orientation of the patient.

raceenumOptional

ethnicityenumOptional

Allowed values:

disability_statusenumOptional

Allowed values:

marital_statusenumOptional

deceaseddatetimeOptional

Time of death for the patient. Leave unset if the patient is not deceased.

multiple_birthintegerOptional

The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth.

emailstringOptional

electronic_communication_opt_inbooleanOptional

photostringOptional

languagestringOptional

external_provenanceobjectOptional

Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data.

non_insurance_payer_associationslist of objectsOptional

guarantorobjectOptional

self_paybooleanOptional

authorizationslist of objectsOptional

referralslist of objectsOptional

primary_service_facility_idstringOptional

do_not_invoice_reasonenumOptional

If this value is defined, the customer will not be invoiced.

Allowed values:

note_idslist of stringsOptional

tag_idslist of stringsOptional

non_insurance_payerslist of stringsOptionalDeprecated

Response

This endpoint returns an object.

biological_sexenum

The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html

Allowed values:

birth_datedate

contactslist of objects

Contacts for the patient.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

filing_orderobject

The patient’s active coverages, in order of primary, secondary, etc.

general_practitionerslist of objects

idstring

The unique UUID identifier for a Patient. Patient ID is used in machine contexts.

mrnstring

The medical record number for the patient. Human-friendly Candid generated MRNs are of the form “YYMMDDXXXX”, where “YYYYMMDD” is the date of patient creation and “XXXX” is a zero-padded incrementing integer.

nameobject

organization_idstring

The organization that owns this object.

other_addresseslist of objects

Other addresses for the patient.

other_nameslist of objects

Other names for the patient.

other_telecomslist of objects

Other phone numbers for the patient.

primary_addressobject

The primary address for the patient.

primary_telecomobject

The primary phone number for the patient.

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

authorizationslist of objectsOptional

deceaseddatetimeOptional

Time of death for the patient. Leave unset if the patient is not deceased.

disability_statusenumOptional

Allowed values:

do_not_invoice_reasonenumOptional

If this value is defined, the customer will not be invoiced.

Allowed values:

electronic_communication_opt_inbooleanOptional

emailstringOptional

ethnicityenumOptional

Allowed values:

external_provenanceobjectOptional

Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data.

genderenumOptional

guarantorobjectOptional

languagestringOptional

marital_statusenumOptional

multiple_birthintegerOptional

The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth.

non_insurance_payer_associationslist of objectsOptional

note_idslist of stringsOptional

other_identifierslist of objectsOptional

Other identifiers for the patient.

photostringOptional

primary_service_facility_idstringOptional

raceenumOptional

referralslist of objectsOptional

self_paybooleanOptional

sexual_orientationenumOptional

The sexual orientation of the patient.

social_security_numberstringOptional

tag_idslist of stringsOptional

non_insurance_payerslist of stringsOptionalDeprecated

Update

Path parameters

Headers

Request

Response

Errors