Use the FHIR R4 (4.0.1) interactions and search parameters advertised by the deployed DDFS capability statement.

Call GET {base}/api/fhir/r4/metadata. Use the returned CapabilityStatement as the authority for the resources, interactions, operations, and search parameters available on the deployed DDFS instance.

• Search: GET /api/fhir/r4/<Resource>?<query-parameters>
• Create: POST /api/fhir/r4/<Resource>
• Read: GET /api/fhir/r4/<Resource>/{rid}
• Update: PUT /api/fhir/r4/<Resource>/{rid}
• Versioned read: GET /api/fhir/r4/<Resource>/{rid}/_history/{vid}
• Logical delete: DELETE /api/fhir/r4/<Resource>/{rid}

A standard DELETE is a logical delete. POST /api/fhir/r4/<Resource>/{rid}/$hardDelete permanently deletes one eligible logically deleted resource. POST /api/fhir/r4/<Resource>/$purgeDeleted permanently deletes eligible logically deleted resources selected by its inputs. Both administrative operations are irreversible and require additional authorization.

Common advertised controls include _count, _total, _id, _lastUpdated, _profile, and _tag. Confirm each control for the target resource.

• Treat _count as a requested maximum page size; a page can contain fewer entries.
• Bundle.total is optional, including when a supported _total mode is requested.
• Follow the URL in Bundle.link whose relation is next verbatim. Do not construct or edit the paging URL.
• Repeat an actual date or instant parameter name to express a supported range, for example birthdate=ge1980-01-01&birthdate=le1990-12-31.

FHIR search URLs can contain PHI. See Protect Sensitive Search Data.

Search: GET /api/fhir/r4/Condition

Advertised parameters include _count, _total, _id, _lastUpdated, _profile, _tag, abatement-date, category, clinical-status, code, encounter, onset-date, patient, and recorded-date.

GET /api/fhir/r4/Condition?_id={rid}&patient=Patient/{patient-id}

{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Condition"}}]}

POST /api/fhir/r4/Condition
Content-Type: application/fhir+json

{
  "resourceType": "Condition",
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "44054006",
        "display": "Diabetes mellitus type 2"
      }
    ]
  },
  "subject": {"reference": "Patient/{rid}"}
}

Search: GET /api/fhir/r4/Device

Advertised parameters include common controls plus patient, status, type, manufacturer, and model.

GET /api/fhir/r4/Device?patient=Patient/{rid}&status=active

{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Device"}}]}

Search: GET /api/fhir/r4/DiagnosticReport

Advertised parameters include common controls plus category, code, date, patient, and status.

GET /api/fhir/r4/DiagnosticReport?patient=Patient/{rid}&date=ge2024-01-01

{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"DiagnosticReport"}}]}

Search: GET /api/fhir/r4/Encounter

Advertised parameters include common controls plus class, date, discharge-disposition, identifier, location, patient, status, and type.

GET /api/fhir/r4/Encounter?patient=Patient/{rid}&status=in-progress

{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Encounter"}}]}

Search: GET /api/fhir/r4/Location

Advertised parameters include common controls plus identifier, status, partof, name, address, address-city, address-state, and address-postalcode.

GET /api/fhir/r4/Location?address-city=Boston&name=Main

{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Location"}}]}

Search: GET /api/fhir/r4/Patient

Advertised parameters include common controls plus birthdate, death-date, family, given, identifier, and name.

GET /api/fhir/r4/Patient?family=Doe&birthdate=ge1980-01-01&birthdate=le1990-12-31

{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Patient"}}]}

Search: GET /api/fhir/r4/Practitioner

Advertised parameters include common controls plus identifier and name.

GET /api/fhir/r4/Practitioner?name=Smith

{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Practitioner"}}]}

For Endpoint, Group, Observation, Organization, PractitionerRole, Provenance, RelatedPerson, ServiceRequest, Specimen, and any other advertised R4 resources, use the applicable resource page and deployed capability statement for the exact interaction, operation, and search-parameter list.