diff --git a/docs/learn/standards/adding-a-communication-standard.md b/docs/learn/standards/adding-a-communication-standard.md index aef7126..0223e08 100644 --- a/docs/learn/standards/adding-a-communication-standard.md +++ b/docs/learn/standards/adding-a-communication-standard.md @@ -15,6 +15,84 @@ erDiagram ## Add communication standard +=== "Request" + + ```json hl_lines="7" + POST https://api.zorgapis.nl/v1beta1/communication-standards HTTP/1.1 + Content-Type: application/json + + --8<-- "learn/standards/snippets/add-communication-standard_request.json" + ``` + + 1. The name of the communication standard, must be **unique** for this organization (see `#!js "organizationId"`). + 2. The UUID of the [organization](../organizations/adding-an-organization.md#add-organization) that maintains the + communication standard. + +=== "Response" + + ```json hl_lines="5 9-12" + HTTP/1.1 201 Created + Content-Type: application/json + + --8<-- "learn/standards/snippets/add-communication-standard_response.json" + ``` + + 1. The Universally Unique Identifier, or UUID (see [RFC 4122]( + https://datatracker.ietf.org/doc/html/rfc4122){: target="_blank" }), assigned to the commmunication standard by + the API server. + +!!! note + + To learn more, view the [API reference]( + https://oas.zorgapis.nl/#tag/communication-standards/operation/addCommunicationStandard){: target="_blank" } + or fork our [Postman Collection]( + https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" } + and explore our API. + ## Add communication standard version +=== "Request" + + ```json hl_lines="7" + POST https://api.zorgapis.nl/v1beta1/communication-standard-versions HTTP/1.1 + Content-Type: application/json + + --8<-- "learn/standards/snippets/add-communication-standard-version_request.json" + ``` + + 1. The name of the communication standard version, must be **unique** for this communication standard (see + `#!js "communicationStandardId"`). + 2. The UUID of the [communication standard](#add-communication-standard) to which this version belongs. + 3. The date and time (formatted as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){: target="_blank" }) at + which the communication standard version was published. In other words, the date and time at which this version + was first made available by the [organization](../organizations/adding-an-organization.md#add-organization) that + maintains the communication standard. + + **Note**: `publishTime` is **not** to be used for the date and time at which this version is published in the + API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item + and can be accessed via read-only property `createTime`. + 4. The [SemVer](https://semver.org/){: target="_blank" } version information. Additional properties for pre-release + (`#!js "preRelease"`) and build metadata (`#!js "build"`) are available. + +=== "Response" + + ```json hl_lines="5 9-12" + HTTP/1.1 201 Created + Content-Type: application/json + + --8<-- "learn/standards/snippets/add-communication-standard-version_response.json" + ``` + + 1. The Universally Unique Identifier, or UUID (see [RFC 4122]( + https://datatracker.ietf.org/doc/html/rfc4122){: target="_blank" }), assigned to the communication standard + version by the API server. + +!!! note + + To learn more, view the [API reference]( + https://oas.zorgapis.nl/#tag/communication-standard-versions/operation/addCommunicationStandardVersion){: target="_blank" } + or fork our [Postman Collection]( + https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" } + and explore our API. + ## Set communication standard main version \ No newline at end of file diff --git a/docs/learn/standards/snippets/add-communication-standard-version_request.json b/docs/learn/standards/snippets/add-communication-standard-version_request.json new file mode 100644 index 0000000..e31d477 --- /dev/null +++ b/docs/learn/standards/snippets/add-communication-standard-version_request.json @@ -0,0 +1,13 @@ +{ + "name": "R5", // (1)! + "description": "FHIR Specification 5.0.0", + "communicationStandardId": "05d8de10-1932-4e7f-badf-655c1a82fcc3", // (2)! + "publishTime": "2023-03-26T12:00:00.0000000Z", // (3)! + "semVer": { // (4)! + "major": 5, + "minor": 0, + "patch": 0 + }, + "lifecycleState": "PUBLISHED", + "url": "https://hl7.org/fhir/R5" +} \ No newline at end of file diff --git a/docs/learn/standards/snippets/add-communication-standard-version_response.json b/docs/learn/standards/snippets/add-communication-standard-version_response.json new file mode 100644 index 0000000..0f7075e --- /dev/null +++ b/docs/learn/standards/snippets/add-communication-standard-version_response.json @@ -0,0 +1,18 @@ +{ + "id": "8ae84d7f-73e7-4f08-b839-c73c97128ada", // (1)! + "name": "R5", + "description": "FHIR Specification 5.0.0", + "communicationStandardId": "05d8de10-1932-4e7f-badf-655c1a82fcc3", + "communicationStandard": { + "id": "05d8de10-1932-4e7f-badf-655c1a82fcc3", + "name": "FHIR" + }, + "publishTime": "2023-03-26T12:00:00.0000000Z", + "semVer": { + "major": 5, + "minor": 0, + "patch": 0 + }, + "lifecycleState": "PUBLISHED", + "url": "https://hl7.org/fhir/R5" +} \ No newline at end of file diff --git a/docs/learn/standards/snippets/add-communication-standard_request.json b/docs/learn/standards/snippets/add-communication-standard_request.json new file mode 100644 index 0000000..9579c9a --- /dev/null +++ b/docs/learn/standards/snippets/add-communication-standard_request.json @@ -0,0 +1,6 @@ +{ + "name": "FHIR", // (1)! + "description": "FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.", + "organizationId": "a70590c6-06ce-4dba-9098-ed996335bdec", // (2)! + "url": "https://hl7.org/fhir/" +} \ No newline at end of file diff --git a/docs/learn/standards/snippets/add-communication-standard_response.json b/docs/learn/standards/snippets/add-communication-standard_response.json new file mode 100644 index 0000000..c249b48 --- /dev/null +++ b/docs/learn/standards/snippets/add-communication-standard_response.json @@ -0,0 +1,11 @@ +{ + "id": "05d8de10-1932-4e7f-badf-655c1a82fcc3", // (1)! + "name": "FHIR", + "description": "FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.", + "organizationId": "a70590c6-06ce-4dba-9098-ed996335bdec", + "organization": { + "id": "a70590c6-06ce-4dba-9098-ed996335bdec", + "name": "HL7 Nederland" + }, + "url": "https://hl7.org/fhir/" +} \ No newline at end of file