Composition
The Composition resource represents a signed form document in Open Aidn.
Open Aidn currently exposes selected fields from the base HL7 FHIR R4 Composition resource. A formal Aidn profile may be published later.
Standards and profiles
- HL7 FHIR R4: Composition
- HL7 FHIR R4 search: FHIR search
Endpoints
| Method | Path | Required scope | Description |
|---|---|---|---|
POST |
/Composition/_search |
composition.search |
Search using application/x-www-form-urlencoded body parameters. |
GET |
/Composition/{id} |
composition.read |
Read one Composition by form ID. |
Search responses are returned as FHIR Bundle resources with type set to searchset.
Search parameters
| Parameter | Type | Description |
|---|---|---|
patient.Identifier |
identifier | Patient identifier used to filter compositions for one patient. |
type |
token | Composition type. Multiple type values can be sent as a comma-separated value. |
_include |
token, repeatable | Adds supported referenced resources to the response bundle. |
patient.Identifier and type are required for search.
Supported document types
The type parameter identifies which document type to search for. Supported values may expand over time. Current examples include:
| Code | System | Notes |
|---|---|---|
A04-2 |
volven:9602 |
Sykepleiesammenfatning. |
B01-2 |
volven:9602 |
Tverrfaglig behandlingsplan. |
445414007 |
http://snomed.info/sct |
Clinical frailty scale. |
Compose the type search parameter as <system>|<code>, for example type=urn:oid:2.16.578.1.12.4.1.1.9602|A04-2. Open Aidn supports both urn:oid:2.16.578.1.12.4.1.1.9602 and volven:9602 as the Volven document type system. Multiple document types can be sent as one comma-separated value without spaces, for example type=volven:9602|A04-2,volven:9602|B01-2.
Supported includes
_include value |
Included resource | Description |
|---|---|---|
Composition:author |
Practitioner |
Adds referenced author resources. |
Composition:subject |
Patient |
Adds referenced patient resources. |
Composition:encounter |
Encounter |
Adds referenced encounter resources. |
Response fields
Open Aidn may expand the response over time, but integrations should currently expect data in these fields:
| Field | Description |
|---|---|
id |
Composition identifier. |
meta.lastUpdated |
Last update timestamp when available. |
type |
Composition type coding. |
status |
FHIR Composition status, such as final, preliminary, or entered-in-error. |
date |
Clinical time for the composition. |
title |
Document title. |
author.reference |
Reference to the authoring practitioner. |
subject.reference |
Reference to the patient. |
encounter.reference |
Reference to the encounter when available. |
section.title |
Section title for each form field. |
section.text.div |
Text value for each form field when available. |
Example search
POST /Composition/_search HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS_TOKEN>
patient.Identifier=<PATIENT_IDENTIFIER>&type=<SYSTEM>|<CODE>&_include=Composition:authorThe response is a FHIR search bundle with matching Composition resources and any requested includes.