POST api/EncounterForm/PublishEncounter
Request Information
URI Parameters
None.
Body Parameters
EncounterForm| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| HealthCenterId | integer |
None. |
|
| ClientNumber | string |
None. |
|
| AttendingPhysicianNPI | string |
None. |
|
| FormStatus | integer |
None. |
|
| DateOfVisit | date |
None. |
|
| VisitType | string |
None. |
|
| PurposeOfVisit | string |
None. |
|
| ReferredToDCS | boolean |
None. |
|
| ConfidentialVisit | boolean |
None. |
|
| FipsCode | string |
None. |
|
| dob | date |
None. |
|
| Gender | string |
None. |
|
| Race | string |
None. |
|
| EthnicOriginHispanic | string |
None. |
|
| Interpreter | boolean |
None. |
|
| TalkAboutContraception | string |
None. |
|
| SexualOrientation | string |
None. |
|
| Education | string |
None. |
|
| Bmi | string |
None. |
|
| CigarettesPerDay | string |
None. |
|
| PregnancyIntention | string |
None. |
|
| OutcomeRecentPregnancy | string |
None. |
|
| MonthlyFamilyIncome | decimal number |
None. |
|
| AnnualFamilyIncome | decimal number |
None. |
|
| FamilySize | integer |
None. |
|
| PovertyStatus | string |
None. |
|
| PrimarySourceOfPayment | string |
None. |
|
| SecondarySourceOfPayment | string |
None. |
|
| PrimaryInsuranceCode | string |
None. |
|
| SecondaryInsuranceCode | string |
None. |
|
| HivTestResult | string |
None. |
|
| HivfuTestResult | string |
None. |
|
| SyphilisRapidTestResult | string |
None. |
|
| HpvTestResult | string |
None. |
|
| SyphilisTestResult | string |
None. |
|
| PapSmearTestResult | string |
None. |
|
| GcTestResult | string |
None. |
|
| CtTestResult | string |
None. |
|
| ContraceptiveBefore | string |
None. |
|
| ContraceptiveAfter | string |
None. |
|
| WhyNoMethodAtIntake | string |
None. |
|
| WhyNoMethod | string |
None. |
|
| Condoms | integer |
None. |
|
| EcpToday | boolean |
None. |
|
| CreatedOn | date |
None. |
|
| CreatedBy | string |
None. |
|
| ModifiedOn | date |
None. |
|
| ModifiedBy | string |
None. |
|
| CounselingEducation | Collection of string |
None. |
|
| Referrals | Collection of string |
None. |
|
| Services | Collection of string |
None. |
|
| ServiceProviders | Collection of string |
None. |
|
| ContraceptiveDeliveryMethods | string |
None. |
|
| GenderIdentity | string |
None. |
|
| AppointmentScheduled | boolean |
None. |
|
| IsEducation | boolean |
None. |
|
| IsTelemedicine | boolean |
None. |
|
| SystolicBloodPressure | string |
None. |
|
| DiastolicBloodPressure | string |
None. |
|
| BodyHeight | string |
None. |
|
| BodyWeight | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"HealthCenterId": 1,
"ClientNumber": "sample string 2",
"AttendingPhysicianNPI": "sample string 3",
"FormStatus": 4,
"DateOfVisit": "2026-07-24T16:04:42.4423789+00:00",
"VisitType": "sample string 5",
"PurposeOfVisit": "sample string 6",
"ReferredToDCS": true,
"ConfidentialVisit": true,
"FipsCode": "sample string 7",
"dob": "2026-07-24T16:04:42.4423789+00:00",
"Gender": "sample string 8",
"Race": "sample string 9",
"EthnicOriginHispanic": "sample string 10",
"Interpreter": true,
"TalkAboutContraception": "sample string 11",
"SexualOrientation": "sample string 12",
"Education": "sample string 13",
"Bmi": "sample string 14",
"CigarettesPerDay": "sample string 15",
"PregnancyIntention": "sample string 16",
"OutcomeRecentPregnancy": "sample string 17",
"MonthlyFamilyIncome": 1.0,
"AnnualFamilyIncome": 1.0,
"FamilySize": 1,
"PovertyStatus": "sample string 18",
"PrimarySourceOfPayment": "sample string 19",
"SecondarySourceOfPayment": "sample string 20",
"PrimaryInsuranceCode": "sample string 21",
"SecondaryInsuranceCode": "sample string 22",
"HivTestResult": "sample string 23",
"HivfuTestResult": "sample string 24",
"SyphilisRapidTestResult": "sample string 25",
"HpvTestResult": "sample string 26",
"SyphilisTestResult": "sample string 27",
"PapSmearTestResult": "sample string 28",
"GcTestResult": "sample string 29",
"CtTestResult": "sample string 30",
"ContraceptiveBefore": "sample string 31",
"ContraceptiveAfter": "sample string 32",
"WhyNoMethodAtIntake": "sample string 33",
"WhyNoMethod": "sample string 34",
"Condoms": 1,
"EcpToday": true,
"CreatedOn": "2026-07-24T16:04:42.4423789+00:00",
"CreatedBy": "sample string 35",
"ModifiedOn": "2026-07-24T16:04:42.4423789+00:00",
"ModifiedBy": "sample string 36",
"CounselingEducation": [
"sample string 1",
"sample string 2"
],
"Referrals": [
"sample string 1",
"sample string 2"
],
"Services": [
"sample string 1",
"sample string 2"
],
"ServiceProviders": [
"sample string 1",
"sample string 2"
],
"ContraceptiveDeliveryMethods": "sample string 37",
"GenderIdentity": "sample string 38",
"AppointmentScheduled": true,
"IsEducation": true,
"IsTelemedicine": true,
"SystolicBloodPressure": "sample string 40",
"DiastolicBloodPressure": "sample string 41",
"BodyHeight": "sample string 42",
"BodyWeight": "sample string 43"
}
application/xml, text/xml
Sample:
<EncounterForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IFHC.Models">
<AnnualFamilyIncome>1</AnnualFamilyIncome>
<AppointmentScheduled>true</AppointmentScheduled>
<AttendingPhysicianNPI>sample string 3</AttendingPhysicianNPI>
<Bmi>sample string 14</Bmi>
<BodyHeight>sample string 42</BodyHeight>
<BodyWeight>sample string 43</BodyWeight>
<CigarettesPerDay>sample string 15</CigarettesPerDay>
<ClientNumber>sample string 2</ClientNumber>
<Condoms>1</Condoms>
<ConfidentialVisit>true</ConfidentialVisit>
<ContraceptiveAfter>sample string 32</ContraceptiveAfter>
<ContraceptiveBefore>sample string 31</ContraceptiveBefore>
<ContraceptiveDeliveryMethods>sample string 37</ContraceptiveDeliveryMethods>
<CounselingEducation xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</CounselingEducation>
<CreatedBy>sample string 35</CreatedBy>
<CreatedOn>2026-07-24T16:04:42.4423789+00:00</CreatedOn>
<CtTestResult>sample string 30</CtTestResult>
<DateOfVisit>2026-07-24T16:04:42.4423789+00:00</DateOfVisit>
<DiastolicBloodPressure>sample string 41</DiastolicBloodPressure>
<EcpToday>true</EcpToday>
<Education>sample string 13</Education>
<EthnicOriginHispanic>sample string 10</EthnicOriginHispanic>
<FamilySize>1</FamilySize>
<FipsCode>sample string 7</FipsCode>
<FormStatus>4</FormStatus>
<GcTestResult>sample string 29</GcTestResult>
<Gender>sample string 8</Gender>
<GenderIdentity>sample string 38</GenderIdentity>
<HealthCenterId>1</HealthCenterId>
<HivTestResult>sample string 23</HivTestResult>
<HivfuTestResult>sample string 24</HivfuTestResult>
<HpvTestResult>sample string 26</HpvTestResult>
<Id>1</Id>
<Interpreter>true</Interpreter>
<IsEducation>true</IsEducation>
<IsTelemedicine>true</IsTelemedicine>
<ModifiedBy>sample string 36</ModifiedBy>
<ModifiedOn>2026-07-24T16:04:42.4423789+00:00</ModifiedOn>
<MonthlyFamilyIncome>1</MonthlyFamilyIncome>
<OutcomeRecentPregnancy>sample string 17</OutcomeRecentPregnancy>
<PapSmearTestResult>sample string 28</PapSmearTestResult>
<PovertyStatus>sample string 18</PovertyStatus>
<PregnancyIntention>sample string 16</PregnancyIntention>
<PrimaryInsuranceCode>sample string 21</PrimaryInsuranceCode>
<PrimarySourceOfPayment>sample string 19</PrimarySourceOfPayment>
<PurposeOfVisit>sample string 6</PurposeOfVisit>
<Race>sample string 9</Race>
<Referrals xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Referrals>
<ReferredToDCS>true</ReferredToDCS>
<SecondaryInsuranceCode>sample string 22</SecondaryInsuranceCode>
<SecondarySourceOfPayment>sample string 20</SecondarySourceOfPayment>
<ServiceProviders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ServiceProviders>
<Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Services>
<SexualOrientation>sample string 12</SexualOrientation>
<SyphilisRapidTestResult>sample string 25</SyphilisRapidTestResult>
<SyphilisTestResult>sample string 27</SyphilisTestResult>
<SystolicBloodPressure>sample string 40</SystolicBloodPressure>
<TalkAboutContraception>sample string 11</TalkAboutContraception>
<VisitType>sample string 5</VisitType>
<WhyNoMethod>sample string 34</WhyNoMethod>
<WhyNoMethodAtIntake>sample string 33</WhyNoMethodAtIntake>
<dob>2026-07-24T16:04:42.4423789+00:00</dob>
</EncounterForm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
integerResponse Formats
application/json, text/json
Sample:
1
application/xml, text/xml
Sample:
<long xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</long>