Skip to content

HeyDonto FHIR R4 API - Foundation (1.0)

The Foundation Module is responsible for the overall infrastructure of the FHIR specification. Every implementer works with the content in the Foundation module whichever way they use FHIR.

The Foundation Module maintains most of the basic documentation for the FHIR specification: FHIR Documentation

Powered by HeyDonto

Foundation Framework

  • Resource - Base resource definition
  • DomainResource - Resource with narrative and extensions
  • Basic - Generic resource for custom content
  • Binary - Raw data content (images, PDFs, documents)
  • Bundle - Container for collections of resources

Content Management Resources

Data Exchange Resources

Relationships with Other Modules

All the other modules depend on the Foundation module:

  • The Exchange module builds on the foundation model by defining the recognized methods for exchange of resources
  • The Terminology module provides the formal basis for using Concepts defined in Code Systems in the definitions
  • The Conformance module provides the basis for extending the foundation for national and local use
  • The Security & Privacy module provides the linking framework to external standards for security and privacy
  • The Implementation Support module builds on the foundation to provide testing and reference implementations

Developmental Roadmap

Several components of the Foundation module have now reached normative status. The focus over the next 18-24 months as the 5th release of FHIR is prepared is to focus on some of the non-normative elements and move them towards normative status, such as Questionnaire, List, DocumentReference and Subscription. Exactly which resources will be candidates for normative release will be driven, in part, by the degree of implementation - and whether that implementation is communicated back to HL7.

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/fhir/foundation/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Basic

Operations

Binary

Operations

Bundle

Operations

CapabilityStatement

Operations

OperationOutcome

Operations

Parameters

Operations

Get FHIR r4 parameterss

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

Query
_countnumber

Number of items to return (default=20).

Example: _count=10
_page_tokenstring

Token for fetching the next page of results.

Example: _page_token=CgYK...
_sortstring

Sort the results by a given field, e.g. _sort=family or _sort=-date.

Example: _sort=family
_elementsstring

Restrict returned fields, e.g. _elements=identifier,name.

Example: _elements=identifier,name
telecomstring

Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].

Example: telecom=telecom=phone|555-555-5555
_idstring

Search for a specific resource by ID, e.g. _id=abc123.

Example: _id=abc123
identifierstring

Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.

Example: identifier=http://hospital.org|12345
_includeArray of strings

Include related resources, e.g. _include=Appointment:patient.

patientstring

Include related patient resources, e.g. patient=Patient/[id]&.

Example: patient=patient=Patient/[id]&
_revincludeArray of strings

Reverse include related resources, e.g. _revinclude=Observation:subject.

_hasstring

Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.

Example: _has=Observation:subject:code=http://loinc.org|1234-5
_tagstring

Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.

Example: _tag=http://example.org/tags|sample-tag
_securitystring

Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.

Example: _security=RBAC|CONFIDENTIAL
_profilestring

Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile.

Example: _profile=http://example.org/fhir/StructureDefinition/custom-profile
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/foundation/site/{siteId}/fhir/parameters?_count=10&_page_token=CgYK...&_sort=family&_elements=identifier%2Cname&telecom=telecom%3Dphone%2C555-555-5555&_id=abc123&identifier=http%3A%2F%2Fhospital.org%2C12345&_include=string&patient=patient%3DPatient%2F%5Bid%5D%26&_revinclude=string&_has=Observation%3Asubject%3Acode%3Dhttp%3A%2F%2Floinc.org%2C1234-5&_tag=http%3A%2F%2Fexample.org%2Ftags%2Csample-tag&_security=RBAC%2CCONFIDENTIAL&_profile=http%3A%2F%2Fexample.org%2Ffhir%2FStructureDefinition%2Fcustom-profile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"
Example: "Bundle"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

identifierobject(Identifier)

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

typeany

Indicates the purpose of this bundle - how it is intended to be used.

Enum"document""message""transaction""transaction-response""batch""batch-response""history""searchset""collection"
Example: "searchset"
_typeobject(Element)

Base definition for all elements in a resource.

timestampstring(date-time)(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

Example: "2024-01-01T00:00:00Z"
_timestampobject(Element)

Base definition for all elements in a resource.

totalnumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

Example: 0
_totalobject(Element)

Base definition for all elements in a resource.

linkArray of objects(Bundle_Link)

A series of links that provide context to this bundle.

Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/parameters/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/parameters/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/parameters/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/parameters/?_count=20"}]
entryArray of objects(Parameters)

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Example: [{"resourceType":"Parameters","parameter":[{"name":"exact","valueBoolean":true},{"name":"property","part":[{"name":"code","valueCode":"focus"},{"name":"value","valueCode":"top"}]},{"name":"patient","resource":{"resourceType":"Patient","id":"example","name":[{"use":"official","family":"Chalmers","given":["Peter","James"]}]}}]}]
signatureobject(Signature)

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Response
application/json
{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 100,
  "link": [
    { … },
    { … },
    { … },
    { … }
  ],
  "entry": [
    { … }
  ]
}

Create FHIR r4 parameters

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

Bodyapplication/jsonrequired
resourceTypeanyrequired

This is a Parameters resource

Value"Parameters"
Example: "Parameters"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

parameterArray of objects(Parameters_Parameter)

A parameter passed to or received from the operation.

Example: [{"name":"exact","valueBoolean":true},{"name":"property","part":[{"name":"code","valueCode":"focus"},{"name":"value","valueCode":"top"}]},{"name":"patient","resource":{"resourceType":"Patient","id":"example","name":[{"use":"official","family":"Chalmers","given":["Peter","James"]}]}}]
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/fhir/foundation/site/{siteId}/fhir/parameters' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Parameters",
    "parameter": [
      {
        "name": "exact",
        "valueBoolean": true
      },
      {
        "name": "property",
        "part": [
          {
            "name": "code",
            "valueCode": "focus"
          },
          {
            "name": "value",
            "valueCode": "top"
          }
        ]
      },
      {
        "name": "patient",
        "resource": {
          "resourceType": "Patient",
          "id": "example",
          "name": [
            {
              "use": "official",
              "family": "Chalmers",
              "given": [
                "Peter",
                "James"
              ]
            }
          ]
        }
      }
    ]
  }'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Parameters resource

Value"Parameters"
Example: "Parameters"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

parameterArray of objects(Parameters_Parameter)

A parameter passed to or received from the operation.

Example: [{"name":"exact","valueBoolean":true},{"name":"property","part":[{"name":"code","valueCode":"focus"},{"name":"value","valueCode":"top"}]},{"name":"patient","resource":{"resourceType":"Patient","id":"example","name":[{"use":"official","family":"Chalmers","given":["Peter","James"]}]}}]
Response
application/json
{
  "resourceType": "Parameters",
  "parameter": [
    { … },
    { … },
    { … }
  ]
}

Get FHIR r4 parameters by ID

Request

Security
bearer or bearer
Path
idstringrequired

ID of the Parameters

siteIdstringrequired

Site identifier

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/foundation/site/{siteId}/fhir/parameters/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Parameters resource

Value"Parameters"
Example: "Parameters"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

parameterArray of objects(Parameters_Parameter)

A parameter passed to or received from the operation.

Example: [{"name":"exact","valueBoolean":true},{"name":"property","part":[{"name":"code","valueCode":"focus"},{"name":"value","valueCode":"top"}]},{"name":"patient","resource":{"resourceType":"Patient","id":"example","name":[{"use":"official","family":"Chalmers","given":["Peter","James"]}]}}]
Response
application/json
{
  "resourceType": "Parameters",
  "parameter": [
    { … },
    { … },
    { … }
  ]
}

Update FHIR r4 parameters

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

idstringrequired

ID of the Parameters to update

Bodyapplication/jsonrequired
resourceTypeanyrequired

This is a Parameters resource

Value"Parameters"
Example: "Parameters"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

parameterArray of objects(Parameters_Parameter)

A parameter passed to or received from the operation.

Example: [{"name":"exact","valueBoolean":true},{"name":"property","part":[{"name":"code","valueCode":"focus"},{"name":"value","valueCode":"top"}]},{"name":"patient","resource":{"resourceType":"Patient","id":"example","name":[{"use":"official","family":"Chalmers","given":["Peter","James"]}]}}]
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/fhir/foundation/site/{siteId}/fhir/parameters/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Parameters",
    "parameter": [
      {
        "name": "exact",
        "valueBoolean": true
      },
      {
        "name": "property",
        "part": [
          {
            "name": "code",
            "valueCode": "focus"
          },
          {
            "name": "value",
            "valueCode": "top"
          }
        ]
      },
      {
        "name": "patient",
        "resource": {
          "resourceType": "Patient",
          "id": "example",
          "name": [
            {
              "use": "official",
              "family": "Chalmers",
              "given": [
                "Peter",
                "James"
              ]
            }
          ]
        }
      }
    ]
  }'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Parameters resource

Value"Parameters"
Example: "Parameters"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

parameterArray of objects(Parameters_Parameter)

A parameter passed to or received from the operation.

Example: [{"name":"exact","valueBoolean":true},{"name":"property","part":[{"name":"code","valueCode":"focus"},{"name":"value","valueCode":"top"}]},{"name":"patient","resource":{"resourceType":"Patient","id":"example","name":[{"use":"official","family":"Chalmers","given":["Peter","James"]}]}}]
Response
application/json
{
  "resourceType": "Parameters",
  "parameter": [
    { … },
    { … },
    { … }
  ]
}

Delete FHIR r4 parameters

Request

Security
bearer or bearer
Path
idstringrequired

ID of the Parameters to delete

siteIdstringrequired

Site identifier

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/fhir/foundation/site/{siteId}/fhir/parameters/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Parameters successfully deleted

Bodyapplication/json
statusTextstringrequired
Example: "OK"
statusnumberrequired
Example: 200
Response
application/json
{
  "statusText": "OK",
  "status": 200
}

Get FHIR r4 parameters history by ID

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

idstringrequired

ID of the Parameters

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/foundation/site/{siteId}/fhir/parameters/{id}/history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"
Example: "Bundle"
typeanyrequired

Indicates that this is a history bundle.

Value"history"
Example: "history"
entryArray of objectsrequired

A list of entries representing historical versions of the resource.

entry[].​fullUrlstringrequired
Example: "https://api.heydonto.com/parameters/6eca4369-7183-446e-bab7-addc609972d3"
entry[].​requestobjectrequired
entry[].​request.​methodstring
Enum"PUT""POST"
Example: "PUT"
entry[].​request.​urlstring
Example: "https://api.heydonto.com/parameters/6eca4369-7183-446e-bab7-addc609972d3"
entry[].​resourceobjectrequired
Example: {"resourceType":"Resource","id":"example"}
entry[].​responseobjectrequired
entry[].​response.​lastModifiedstring(date-time)
Example: "2024-10-29T01:05:22.739517+00:00"
entry[].​response.​locationstring
Example: "https://api.heydonto.com/parameters/6eca4369-7183-446e-bab7-addc609972d3/_history/MTczMDE2MzkyMjczOTUxNzAwMA"
entry[].​response.​statusstring
Example: "200 OK"
totalintegerrequired
Example: 2
Response
application/json
{
  "resourceType": "Bundle",
  "type": "history",
  "entry": [
    { … }
  ],
  "total": 2
}