FHIR Dosage Input

The input representation of dosage information for a patient’s medication.

The Dosage FHIR resource maps to the PatientMedicationDosage object in Salesforce.

Root XML tag

<FhirDosageInput>

JSON example

1{
2   "sequence":"10.0",
3   "text":"commentsText",
4   "additionalInstruction":"Additioanl Instructions",
5   "patientInstruction":"Patient Instructions",
6   "asNeeded":"true",
7   "site":{
8   "salesforceId":"0iPxx00000000MbEAI" },
9   "route":{
10   "codeableConcept":{
11   "text":"Burn of Ear route",
12   "coding":[
13   {
14   "display":"Burn of ear route",
15   "code":"123456700",
16   "system":"http://sfdc.co",
17   "version":"2.16.840.1.113883.6.96",
18   "isActive":true,
19   "isPrimary":true,
20   "use":"Clinical",
21   "userSelected":true,
22   "startDate":"1993-11-09T15:40:30.000Z",
23   "endDate":"2021-08-24T17:00:00.000Z",
24   } ]
25   }
26   },
27   "method":{
28   "codeableConcept":{
29   "text":"Burn of Ear Method",
30   "coding":[
31   {
32   "display":"Burn of ear",
33   "code":"1234567777",
34   "system":"http://sfdc.co",
35   "version":"2.16.840.1.113883.6.96",
36   "isActive":true,
37   "isPrimary":true,
38   "use":"Clinical",
39   "userSelected":true,
40   "startDate":"1993-11-09T15:40:30.000Z",
41   "endDate":"2021-08-24T17:00:00.000Z",
42   } ]
43   }
44   },
45   "doseAndRate":{
46   "type":"Ordered",
47   "dose":{
48   "dosageQuantityType":"Dose",
49   "dosageQuantityNumerator":"10",
50   "dosageQuantityDenominator":"20",
51   "dosageUnit":{
52   "unitOfMeasure":{
53   "unitCode":"MGTest",
54   "description":"MG description",
55   "type":"Custom" }
56   }
57   },
58   "rate":{
59   "dosageRateType":"Frequency Ratio",
60   "dosageRateNumerator":"2",
61   "dosageRateDenominator":"3",
62   "dosageRateUnit":{
63   "salesforceId":"0hExx0000000001EAA" }
64   }
65   },
66   "sourceSystem":"http://sfdc.co",
67   "sourceSystemId":"567890",
68   "sourceSystemModified":"2012-07-26T15:40:30.000Z" 
69}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalInformation`	Custom Field Value Input[]	The additional information associated with the medication for the patient.	Optional	54.0
`additionalInstruction`	String	The supplemental instructions or warnings associated with the medication for the patient.	Optional	54.0
`asNeeded`	Boolean	Indicates whether the medication is taken on an as-needed basis.	Optional	54.0
`doseAndRate`	FHIR Dose And Rate Input	The amount of dosage administration.	Optional	54.0
`method`	FHIR Codeable Concept Or ID Input	The method of dosage administration.	Optional	54.0
`patientInstruction`	String	The patient or consumer instructions associated with this medication.	Optional	54.0
`route`	FHIR Codeable Concept Or ID Input	The route of dosage adminisitration.	Optional	54.0
`sequence`	Double	The position of this medication in the sequence of medications prescribed to a patient.	Optional	54.0
`site`	FHIR Codeable Concept Or ID Input	The site of dosage adminisitration.	Optional	54.0
`sourceSystem`	String	The source system from where the dosage record was brought into Salesforce.	Optional	54.0
`sourceSystemId`	String	The identifier of the dosage record in its source system.	Optional	54.0
`sourceSystemModified`	String	The date and time when the dosage record was last modified in its source system.	Optional	54.0
`text`	String	The free text dosage instructions associated with the medication for the patient.	Optional	54.0