Medplum

https://www.medplum.com/docs
Admin
Medplum is a healthcare platform that helps you set up and run your medical applications in minutes,...
Tokens:1,687,017
Snippets:18,265
Trust Score:8.7
Update:5 days ago
Show doc for...
Tokens:
Raw
### Example Command Line Execution

Source: https://www.medplum.com/docs/agent/configuration

Basic example of starting the agent with required parameters.

```bash
npm run agent https://api.medplum.com my-client-id my-client-secret 123e4567-e89b-12d3-a456-426614174000
```

--------------------------------

### Example Command Line with Log Level

Source: https://www.medplum.com/docs/agent/configuration

Example of starting the agent with a specified log level.

```bash
npm run agent https://api.medplum.com my-client-id my-client-secret 123e4567-e89b-12d3-a456-426614174000 DEBUG
```

--------------------------------

### Client Credentials Profile Setup

Source: https://www.medplum.com/docs/cli/external-fhir-servers

Example command to configure a profile using client-credentials authentication.

```bash
medplum profile set example \

    --auth-type "client-credentials" \

    --base-url "https://api.example.com" \

    --fhir-url-path "fhir/R4" \

    --token-url "oauth2/token" \

    --client-id "MY_CLIENT_ID" \

    --client-secret "MY_CLIENT_SECRET"
```

--------------------------------

### Basic Auth Profile Setup

Source: https://www.medplum.com/docs/cli/external-fhir-servers

Example command to configure a profile using basic authentication.

```bash
medplum profile set example \

    --auth-type "basic" \

    --base-url "https://api.example.com" \

    --fhir-url-path "fhir/R4" \

    --client-id "MY_CLIENT_ID" \

    --client-secret "MY_CLIENT_SECRET"
```

--------------------------------

### Example GET Request

Source: https://www.medplum.com/docs/api/fhir/operations/claim-export

A concrete example of an instance-level GET request for a specific claim.

```http
GET /fhir/R4/Claim/claim123/$export
```

--------------------------------

### User Login / Authorization Code Profile Setup

Source: https://www.medplum.com/docs/cli/external-fhir-servers

Example command to configure a profile using authorization-code authentication.

```bash
medplum profile set example \

    --base-url "https://api.example.com" \

    --fhir-url-path "fhir/R4" \

    --authorize-url "oauth2/authorize" \

    --token-url "oauth2/token"
```

--------------------------------

### Start and enable Nginx

Source: https://www.medplum.com/docs/self-hosting/install-from-scratch

Start the Nginx service and ensure it starts automatically on system boot.

```bash
sudo systemctl start nginx  
sudo systemctl enable nginx  
```

--------------------------------

### GET /Patient?_offset=20

Source: https://www.medplum.com/docs/search/paginated-search

Offset-based pagination using the _offset parameter to skip a specified number of results. This example returns results starting from the 21st matching Patient resource.

```APIDOC
## GET /Patient?_offset=20

### Description
Offset-based pagination using the _offset parameter to skip a specified number of results. This example returns results starting from the 21st matching Patient resource.

### Method
GET

### Endpoint
/Patient?_offset=20

### Parameters
#### Query Parameters
- **_offset** (integer) - Required - The number of results to skip. _offset=0 returns the first page. Maximum supported value is 10,000.

### Request Example
GET /Patient?_offset=20

### Response
#### Success Response (200)
Returns a Bundle of Patient resources starting from the 21st matching resource.

### Notes
- The _offset parameter translates to a SQL LIMIT clause.
- Offset-based pagination is best for smaller datasets, jumping to specific pages, or when total result count is important.
```

--------------------------------

### Start the API server

Source: https://www.medplum.com/docs/contributing/run-the-stack

Navigate to the server package and start the development server.

```bash
cd packages/server  

npm run dev  
```

--------------------------------

### Sample GET request

Source: https://www.medplum.com/docs/api/oauth/userinfo

Example of a GET request to the userinfo endpoint including the required Authorization header.

```http
GET https://api.medplum.com/oauth2/userinfo  

    Authorization: Bearer <access_token>
```

--------------------------------

### Start the development server

Source: https://www.medplum.com/docs/provider

Navigate to your project directory and start the development server to run your forked application locally.

```bash
cd <your-project-name>

npm run dev
```

--------------------------------

### Referral Note Generation via GET

Source: https://www.medplum.com/docs/api/fhir/operations/ccda-export

Example of passing parameters as query string values using a GET request.

```bash
curl 'https://api.medplum.com/fhir/R4/Patient/<PATIENT_ID>/$ccda-export?type=referral' \  

  -H 'Authorization: Bearer <ACCESS_TOKEN>'  
```

--------------------------------

### Start the Web App

Source: https://www.medplum.com/docs/contributing/run-the-stack

Navigate to the app package and start the development server for the web application.

```bash
cd packages/app  

npm run dev  
```

--------------------------------

### Invoke $extract via GET request

Source: https://www.medplum.com/docs/api/fhir/operations/extract

Example of invoking the $extract operation using a GET request on a specific resource ID.

```http
GET https://api.medplum.com/fhir/R4/QuestionnaireResponse/1c503f4e-a08c-4b7d-8ebd-bfc67b0ab761/$extract
```

--------------------------------

### Build and run the application

Source: https://www.medplum.com/docs/self-hosting/branding

Commands to navigate to the app directory, build the project, and start the development server.

```bash
cd packages/app

npm run build

npm run dev
```

--------------------------------

### Check code relationship via GET request

Source: https://www.medplum.com/docs/api/fhir/operations/codesystem-subsumes

Example GET request to check if SNOMED code 364075005 is a descendant of 363787002.

```http
GET https://api.medplum.com/fhir/R4/CodeSystem/$subsumes?system=http://snomed.info/sct&codeA=364075005&codeB=363787002  
```

--------------------------------

### Create a Binary resource example

Source: https://www.medplum.com/docs/sdk/core.medplumclient.createbinary

An example showing how to create a Binary resource using a file, filename, and content type.

```typescript
const result = await medplum.createBinary(myFile, 'test.jpg', 'image/jpeg');

console.log(result.id);
```

--------------------------------

### Example: Cancel a Bulk Export

Source: https://www.medplum.com/docs/api/fhir/operations/asyncjob-cancel

A workflow example showing how to start a bulk export and subsequently cancel it using the returned job ID.

```bash
# Start a bulk export
curl -X GET 'https://api.medplum.com/fhir/R4/$export' \
  -H "Authorization: Bearer MY_ACCESS_TOKEN" \
  -H "Prefer: respond-async"

# Response includes Content-Location header
# Content-Location: https://api.medplum.com/fhir/R4/AsyncJob/abc123

# Cancel the export if needed
curl -X POST 'https://api.medplum.com/fhir/R4/AsyncJob/abc123/$cancel' \
  -H "Authorization: Bearer MY_ACCESS_TOKEN"
```

--------------------------------

### medplum agent status examples

Source: https://www.medplum.com/docs/agent/agent-cli-commands

Examples showing how to get status for specific agents, using search criteria, and outputting in JSON format.

```bash
# Get status for specific agents  

medplum agent status 123e4567-e89b-12d3-a456-426614174000 123e4567-e89b-12d3-a456-426614174001  

  

# Get status using search criteria  

medplum agent status --criteria "Agent?name=Test Agent"  

  

# Get status in JSON format  

medplum agent status --criteria "Agent?name=Test Agent" --output json
```

--------------------------------

### Install dependencies and build the application

Source: https://www.medplum.com/docs/self-hosting/install-on-azure

Install the necessary dependencies and perform a fast build of the application after configuring the environment variables.

```bash
npm ci --include dev  

npm run build:fast  
```

--------------------------------

### CodeSystem $lookup Request

Source: https://www.medplum.com/docs/api/fhir/operations/codesystem-lookup

An example GET request to the $lookup operation for a specific LOINC code.

```http
GET /CodeSystem/$lookup?system=http://loinc.org&code=8867-4
```

--------------------------------

### Upgrade Agent Examples

Source: https://www.medplum.com/docs/agent/agent-cli-commands

Examples showing how to upgrade specific agents, use search criteria, or specify a target version.

```bash
# Upgrade specific agents to latest version  

medplum agent upgrade 123e4567-e89b-12d3-a456-426614174000 123e4567-e89b-12d3-a456-426614174001  

  

# Upgrade using search criteria  

medplum agent upgrade --criteria "Agent?name=Test Agent"  

  

# Upgrade to specific version  

medplum agent upgrade --criteria "Agent?name=Test Agent" --version 1.2.3
```

--------------------------------

### Run the application

Source: https://www.medplum.com/docs/tutorials/medplum-hello-world

Start the development server to run the application locally.

```bash
npm run dev  
```

--------------------------------

### JWT Assertion Profile Setup

Source: https://www.medplum.com/docs/cli/external-fhir-servers

Example command to configure a profile using jwt-assertion authentication.

```bash
medplum profile set example \

    --auth-type "jwt-assertion" \

    --base-url "https://api.example.com" \

    --fhir-url-path "fhir/R4" \

    --token-url "/oauth2/token" \

    --client-id "MY_CLIENT_ID" \

    --audience "/oauth2/token" \

    --subject "john_doe" \

    --private-key-path "/path/to/privatekey.pem"
```

--------------------------------

### Run server with custom config and profiler

Source: https://www.medplum.com/docs/contributing/server-profiling

Start the server with the profiler and a specified custom configuration file.

```bash
NODE_ENV=production node --prof dist/index.js file:medplum.docker.config.json
```

--------------------------------

### JWT Bearer Profile Setup

Source: https://www.medplum.com/docs/cli/external-fhir-servers

Example command to configure a profile using jwt-bearer authentication.

```bash
medplum profile set example \

    --auth-type "jwt-bearer" \

    --base-url "https://api.example.com" \

    --fhir-url-path "fhir/R4" \

    --token-url "/oauth2/token" \

    --client-id "MY_CLIENT_ID" \

    --client-secret "MY_CLIENT_SECRET"  

    --scope "openid profile"  

    --audience "/oauth2/token"  

    --subject "john_doe"  

    --issuer "api.example.com"
```

--------------------------------

### MedplumClient.startClientLogin() usage example

Source: https://www.medplum.com/docs/sdk/core.medplumclient.startclientlogin

An example showing how to initiate the client login and perform a subsequent resource search.

```typescript
await medplum.startClientLogin(import.meta.env.MEDPLUM_CLIENT_ID, import.meta.env.MEDPLUM_CLIENT_SECRET)

// Example Search

await medplum.searchResources('Patient')
```

--------------------------------

### Copying a starter bot

Source: https://www.medplum.com/docs/bots/bots-in-production

Commands to navigate to the source directory and copy an existing bot example to a new file.

```bash
cd src  

cp examples/hello-patient.ts my-first-bot.ts  
```

--------------------------------

### GraphDefinition resource example

Source: https://www.medplum.com/docs/api/fhir/operations/resource-graph

Defines a graph structure starting from a Patient resource, linking to Observations and Practitioners.

```json
{

  "resourceType": "GraphDefinition",

  "name": "patient-with-observations",

  "status": "active",

  "start": "Patient",

  "link": [

    {

      "target": [

        {

          "type": "Observation",

          "params": "subject={ref}",

          "link": [

            {

              "path": "performer",

              "target": [

                {

                  "type": "Practitioner"

                }

              ]

            }

          ]

        }

      ]

    },

    {

      "path": "generalPractitioner",

      "target": [

        {

          "type": "Practitioner"

        }

      ]

    }

  ]

}
```

--------------------------------

### Example Field Configurations

Source: https://www.medplum.com/docs/api/fhir/operations/csv

Various ways to configure the _fields parameter using search parameters or FHIRPath.

```text
_fields=name,birthDate,gender

_fields=identifier,name,telecom,address

_fields=Patient.name.family,Patient.name.given
```

--------------------------------

### Invoke Custom FHIR Operations

Source: https://www.medplum.com/docs/api/fhir/operations/custom-operations

Examples of how to invoke custom operations using POST and GET requests once configured.

```http
POST [base]/[ResourceType]/$my-operation  

GET [base]/[ResourceType]/[id]/$my-operation  
```

--------------------------------

### GET Agent/$bulk-status?name=Production+Agent

Source: https://www.medplum.com/docs/agent/using-search-parameters

Selects all agents whose name starts with the given prefix and runs the $bulk-status operation on them.

```APIDOC
## [GET] Agent/$bulk-status?name=Production+Agent

### Description
Selects all agents whose name starts with the given prefix and runs the $bulk-status operation on them.

### Method
GET

### Endpoint
Agent/$bulk-status?name=Production+Agent

### Parameters
#### Query Parameters
- **name** (string) - Required - The agent's name; matches by prefix.

### Request Example
medplum get 'Agent/$bulk-status?name=Production+Agent'

### Response
#### Success Response (200)
- **Bundle** - A Bundle of Parameters, one entry per matched agent.

#### Response Example
{
  "resourceType": "Bundle",
  "entry": [
    {
      "resource": {
        "resourceType": "Parameters"
      }
    }
  ]
}
```

--------------------------------

### Configure Different Log Levels

Source: https://www.medplum.com/docs/agent/configuration

Example showing how to set the main logger to INFO and the channel logger to DEBUG.

```text
logger.main.logLevel=INFO

logger.channel.logLevel=DEBUG
```

--------------------------------

### Start background services with Docker

Source: https://www.medplum.com/docs/contributing/run-the-stack

Use docker-compose to start PostgreSQL and Redis. If the first command fails, try the second.

```bash
docker-compose up  
```

```bash
docker compose up  
```

--------------------------------

### Recursive Patient Link Search

Source: https://www.medplum.com/docs/search/includes

Example of a GET request using the :iterate modifier to recursively follow Patient links.

```http
GET /fhir/R4/Patient?_id=1&_include:iterate=Patient:link
```
Tokens:
Raw