Composition
Semantical type
The “type” field of the resource is used to determine the semantical type of the resource. It is mandantory. Look at the List of registered codes for a complete list of codes registered in MIDATA. Include the required codes into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a subject which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “subject”
If a resource with no subject field is send to MIDATA, the backend will set the subject to the current user.
Read
Read a single Composition by id.
Request:
[GET] /fhir/Composition/<id>
Read specific version
Read a specific version of a single Composition by id.
Request:
[GET] /fhir/Composition/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Composition/<id>/_history
Search
Search for resources of type Composition
Request:
[GET] /fhir/Composition?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | string | The resource identity |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| attester | reference | Who attested the composition |
| author | reference | Who and/or what authored the composition |
| category | token | Categorization of Composition |
| confidentiality | token | As defined by affinity domain |
| context | token | Code(s) that apply to the event being documented |
| date | date | Composition editing time |
| encounter | reference | Context of the Composition |
| entry | reference | A reference to data that supports this section |
| identifier | token | Version-independent identifier for the Composition |
| patient | reference | Who and/or what the composition is about |
| period | date | The period covered by the documentation |
| related-id | token | Target of the relationship |
| related-ref | reference | Target of the relationship |
| section | token | Classification of section (recommended) |
| status | token | preliminary - final - amended - entered-in-error |
| subject | reference | Who and/or what the composition is about |
| title | string | Human Readable name/title |
| type | token | Kind of composition (LOINC if possible) |
Create
Create a new resource of type Composition.
Request:
[POST] /fhir/Composition
Update
Updates a resource of type Composition.
Request:
[PUT] /fhir/Composition/<id>
Operations
The resource suppports the $document operation. View spec. for $document