> For the complete documentation index, see [llms.txt](https://constanza-gobbo.gitbook.io/technical-documentation-portfolio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://constanza-gobbo.gitbook.io/technical-documentation-portfolio/medisync-api/medisync-api-getting-started-guide-sample.md).

# MediSync API ‐ Getting Started Guide ‐ Sample

*This is a simulated contractor brief I completed to demonstrate API documentation skills. The intended audience is backend developers with REST APIs experience but no FHIR background. The intent of this guide is to take developers from zero to a working API call. This is not intended to be a full reference document.*

MediSync is a health data interoperability platform that allows healthcare applications to read and write patient records, appointments, and clinical notes. It follows the FHIR R4 standard for data structures, wrapped in a simplified REST API so you don't need prior FHIR experience to get started. By the end of this guide, you will have authenticated with the MediSync API, retrieved a patient record, and created an appointment. All requests and responses use JSON.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://constanza-gobbo.gitbook.io/technical-documentation-portfolio/medisync-api/medisync-api-getting-started-guide-sample.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.