From 4724492ca3cd954faa187c9802f766f44acdaf68 Mon Sep 17 00:00:00 2001 From: iMvBremen Date: Fri, 20 Sep 2024 10:46:19 +0200 Subject: [PATCH 1/5] Add InformationStandard endpoints --- src/dist/v1beta1.yaml | 1485 +++++++++++++---- src/v1beta1/_parameters.yaml | 10 + src/v1beta1/_schemas.yaml | 26 + .../_paths/api-specifications#description.md | 4 + .../versions/_paths/versions#description.md | 4 + .../ApiSpecificationVersion_CreateRead.yaml | 4 + .../BasicApiSpecificationVersion.yaml | 12 + ...rsions_{informationStandardVersionId}.yaml | 66 + .../path/informationStandardVersionId.yaml | 9 + ...formation-standard-versions#description.md | 116 ++ .../_paths/information-standard-versions.yaml | 78 + ...rsions_{informationStandardVersionId}.yaml | 76 + .../BasicInformationStandardVersion.yaml | 37 + .../_schemas/InformationStandardVersion.yaml | 75 + ...InformationStandardVersion_CreateRead.yaml | 5 + .../InformationStandardVersion_Update.yaml | 8 + .../MainInformationStandardVersion.yaml | 9 + .../path/informationStandardId.yaml | 9 + .../information-standards#description.md | 68 + .../_paths/information-standards.yaml | 78 + ...ion-standards_{informationStandardId}.yaml | 76 + .../_schemas/BasicInformationStandard.yaml | 21 + .../_schemas/InformationStandard.yaml | 65 + .../_schemas/InformationStandard_Create.yaml | 9 + .../InformationStandard_Create_Response.yaml | 12 + .../_schemas/InformationStandard_Read.yaml | 5 + .../_schemas/InformationStandard_Update.yaml | 8 + src/v1beta1/openapi.yaml | 33 + 28 files changed, 2095 insertions(+), 313 deletions(-) create mode 100644 src/v1beta1/api-specifications/versions/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml create mode 100644 src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml create mode 100644 src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md create mode 100644 src/v1beta1/information-standard-versions/_paths/information-standard-versions.yaml create mode 100644 src/v1beta1/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml create mode 100644 src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml create mode 100644 src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml create mode 100644 src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_CreateRead.yaml create mode 100644 src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml create mode 100644 src/v1beta1/information-standard-versions/_schemas/MainInformationStandardVersion.yaml create mode 100644 src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml create mode 100644 src/v1beta1/information-standards/_paths/information-standards#description.md create mode 100644 src/v1beta1/information-standards/_paths/information-standards.yaml create mode 100644 src/v1beta1/information-standards/_paths/information-standards_{informationStandardId}.yaml create mode 100644 src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml create mode 100644 src/v1beta1/information-standards/_schemas/InformationStandard.yaml create mode 100644 src/v1beta1/information-standards/_schemas/InformationStandard_Create.yaml create mode 100644 src/v1beta1/information-standards/_schemas/InformationStandard_Create_Response.yaml create mode 100644 src/v1beta1/information-standards/_schemas/InformationStandard_Read.yaml create mode 100644 src/v1beta1/information-standards/_schemas/InformationStandard_Update.yaml diff --git a/src/dist/v1beta1.yaml b/src/dist/v1beta1.yaml index 16972f2..0b66048 100644 --- a/src/dist/v1beta1.yaml +++ b/src/dist/v1beta1.yaml @@ -68,6 +68,9 @@ tags: - name: api-specifications.versions.communication-standard-versions description: API specification version communication standard versions API x-displayName: API specification version communication standard versions + - name: api-specifications.versions.information-standard-versions + description: API specification version information standard versions API + x-displayName: API specification version information standard versions - name: api-specifications.versions.trust-framework-versions description: API specification version trust framework versions API x-displayName: API specification version trust framework versions @@ -77,6 +80,12 @@ tags: - name: communication-standard-versions description: Communication standard versions API x-displayName: Communication standard versions + - name: information-standards + description: Information standards API + x-displayName: Information standards + - name: information-standard-versions + description: Information standard versions API + x-displayName: Information standard versions - name: trust-frameworks description: Trust frameworks API x-displayName: Trust frameworks @@ -1314,6 +1323,10 @@ paths: | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `mainVersion.informationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.informationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.informationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `mainVersion.informationStandardVersions.$it.informationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.informationStandardVersions,eq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.informationStandardVersions,neq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(mainVersion.trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | @@ -1594,6 +1607,10 @@ paths: | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `informationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(informationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `informationStandardVersions.$it.informationStandardId` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(informationStandardVersions,neq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | @@ -3161,6 +3178,73 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' + /api-specifications/{apiSpecificationId}/versions/{versionId}/information-standard-versions/{informationStandardVersionId}: + put: + summary: Set an information standard version for an API specification version + description: | + Sets a single information standard version for an API specification version. + operationId: setApiSpecificationVersionInformationStandardVersion + security: + - oauth2: + - api-specifications:write + tags: + - api-specifications.versions.information-standard-versions + parameters: + - $ref: '#/components/parameters/apiSpecificationId' + - $ref: '#/components/parameters/versionId' + - $ref: '#/components/parameters/informationStandardVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + delete: + summary: Delete an information standard version from an API specification version + description: | + Deletes a single information standard version from an API specification version. + operationId: deleteApiSpecificationVersionInformationStandardVersion + security: + - oauth2: + - api-specifications:write + tags: + - api-specifications.versions.information-standard-versions + parameters: + - $ref: '#/components/parameters/apiSpecificationId' + - $ref: '#/components/parameters/versionId' + - $ref: '#/components/parameters/informationStandardVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' /api-specifications/{apiSpecificationId}/versions/{versionId}/trust-framework-versions/{trustFrameworkVersionId}: put: summary: Set a trust framework version for an API specification version @@ -3724,11 +3808,11 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' - /trust-frameworks: + /information-standards: get: - summary: List all trust frameworks + summary: List all information standards description: |- - Returns a list of trust frameworks. + Returns a list of information standards.
Details @@ -3766,17 +3850,17 @@ paths: |------------------------------|-------------------------|----------|----------------------------------------------------------------------| | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"MedMij Afsprakenstelsel")` | - | | | `neq` | `?filter=neq(name,"MedMij Afsprakenstelsel")` | - | | | `has` | `?filter=has(name,"MedMij")` | - | | | `stw` | `?filter=stw(name,"MedMij")` | - | | | `enw` | `?filter=enw(name,"Afsprakenstelsel")` | + | `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | + | | | `neq` | `?filter=neq(name,"FHIR")` | + | | | `has` | `?filter=has(name,"FH")` | + | | | `stw` | `?filter=stw(name,"FH")` | + | | | `enw` | `?filter=enw(name,"IR")` | | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"MedMij Afsprakenstelsel")` | - | | | `neq` | `?filter=neq(description,"MedMij Afsprakenstelsel")` | - | | | `has` | `?filter=has(description,"MedMij")` | - | | | `stw` | `?filter=stw(description,"MedMij")` | - | | | `enw` | `?filter=enw(description,"Afsprakenstelsel")` | + | `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | + | | | `neq` | `?filter=neq(description,"FHIR")` | + | | | `has` | `?filter=has(description,"FH")` | + | | | `stw` | `?filter=stw(description,"FH")` | + | | | `enw` | `?filter=enw(description,"IR")` | | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | @@ -3796,12 +3880,12 @@ paths: | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` |
- operationId: listTrustFrameworks + operationId: listInformationStandards security: - oauth2: - - trust-frameworks:read + - information-standards:read tags: - - trust-frameworks + - information-standards parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/skip' @@ -3816,7 +3900,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/TrustFramework_Read' + $ref: '#/components/schemas/InformationStandard_Read' headers: Total-Count: $ref: '#/components/headers/Total-Count' @@ -3835,28 +3919,28 @@ paths: 5XX: $ref: '#/components/responses/InternalError' post: - summary: Add a trust framework + summary: Add an information standard description: | - Adds a trust framework to the collection. - operationId: addTrustFramework + Adds an information standard to the collection. + operationId: addInformationStandard security: - oauth2: - - trust-frameworks:write + - information-standards:write tags: - - trust-frameworks + - information-standards requestBody: - description: Trust framework object to add + description: Information standard object to add content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Create' + $ref: '#/components/schemas/InformationStandard_Create' responses: '201': description: Created content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Create_Response' + $ref: '#/components/schemas/InformationStandard_Create_Response' '400': $ref: '#/components/responses/BadRequestError' '401': @@ -3871,26 +3955,26 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' - /trust-frameworks/{trustFrameworkId}: + /information-standards/{informationStandardId}: get: - summary: Get a trust framework by ID + summary: Get an information standard by ID description: | - Returns a single trust framework. - operationId: getTrustFrameworkById + Returns a single information standard. + operationId: getInformationStandardById security: - oauth2: - - trust-frameworks:read + - information-standards:read tags: - - trust-frameworks + - information-standards parameters: - - $ref: '#/components/parameters/trustFrameworkId' + - $ref: '#/components/parameters/informationStandardId' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Read' + $ref: '#/components/schemas/InformationStandard_Read' '400': $ref: '#/components/responses/BadRequestError' '401': @@ -3908,30 +3992,30 @@ paths: 5XX: $ref: '#/components/responses/InternalError' patch: - summary: Update a trust framework + summary: Update an information standard description: | - Updates a single trust framework. - operationId: updateTrustFramework + Updates a single information standard. + operationId: updateInformationStandard security: - oauth2: - - trust-frameworks:write + - information-standards:write tags: - - trust-frameworks + - information-standards parameters: - - $ref: '#/components/parameters/trustFrameworkId' + - $ref: '#/components/parameters/informationStandardId' requestBody: - description: Updated trust framework object + description: Updated information standard object content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Update' + $ref: '#/components/schemas/InformationStandard_Update' responses: '200': description: Updated content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Read' + $ref: '#/components/schemas/InformationStandard_Read' '400': $ref: '#/components/responses/BadRequestError' '401': @@ -3948,11 +4032,11 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' - /trust-framework-versions: + /information-standard-versions: get: - summary: List all trust framework versions + summary: List all information standard versions description: |- - Returns a list of trust framework versions. + Returns a list of information standard versions.
Details @@ -3998,82 +4082,82 @@ paths: The following table lists the field names and operators you can use in a filter expression. - | Field | Type | Operator | Example | - |---------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------| - | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | - | | | `neq` | `?filter=neq(name,"1.2.0")` | - | | | `has` | `?filter=has(name,"1.2")` | - | | | `stw` | `?filter=stw(name,"1.2")` | - | | | `enw` | `?filter=enw(name,"2.0")` | - | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | - | | | `neq` | `?filter=neq(description,"1.2.0")` | - | | | `has` | `?filter=has(description,"1.2")` | - | | | `stw` | `?filter=stw(description,"1.2")` | - | | | `enw` | `?filter=enw(description,"2.0")` | - | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | - | `trustFrameworkId` | `uuid` | `eq` | `?filter=eq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | - | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | - | | | `neq` | `?filter=neq(semVer.major,1)` | - | | | `gt` | `?filter=gt(semVer.major,1)` | - | | | `gte` | `?filter=gte(semVer.major,1)` | - | | | `lt` | `?filter=lt(semVer.major,1)` | - | | | `lte` | `?filter=lte(semVer.major,1)` | - | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | - | | | `neq` | `?filter=neq(semVer.minor,2)` | - | | | `gt` | `?filter=gt(semVer.minor,2)` | - | | | `gte` | `?filter=gte(semVer.minor,2)` | - | | | `lt` | `?filter=lt(semVer.minor,2)` | - | | | `lte` | `?filter=lte(semVer.minor,2)` | - | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | - | | | `neq` | `?filter=neq(semVer.patch,0)` | - | | | `gt` | `?filter=gt(semVer.patch,0)` | - | | | `gte` | `?filter=gte(semVer.patch,0)` | - | | | `lt` | `?filter=lt(semVer.patch,0)` | - | | | `lte` | `?filter=lte(semVer.patch,0)` | - | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | - | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | - | | | `has` | `?filter=has(semVer.preRelease,"be")` | - | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | - | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | - | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | - | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | - | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | - | | | `has` | `?filter=has(semVer.build,"exp.sha")` | - | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | - | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | - | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | - | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | - | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | - | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | - | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + | Field | Type | Operator | Example | + |---------------------------|-------------------------|----------|-------------------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | + | | | `neq` | `?filter=neq(name,"1.2.0")` | + | | | `has` | `?filter=has(name,"1.2")` | + | | | `stw` | `?filter=stw(name,"1.2")` | + | | | `enw` | `?filter=enw(name,"2.0")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | + | | | `neq` | `?filter=neq(description,"1.2.0")` | + | | | `has` | `?filter=has(description,"1.2")` | + | | | `stw` | `?filter=stw(description,"1.2")` | + | | | `enw` | `?filter=enw(description,"2.0")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | + | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | + | | | `neq` | `?filter=neq(semVer.major,1)` | + | | | `gt` | `?filter=gt(semVer.major,1)` | + | | | `gte` | `?filter=gte(semVer.major,1)` | + | | | `lt` | `?filter=lt(semVer.major,1)` | + | | | `lte` | `?filter=lte(semVer.major,1)` | + | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | + | | | `neq` | `?filter=neq(semVer.minor,2)` | + | | | `gt` | `?filter=gt(semVer.minor,2)` | + | | | `gte` | `?filter=gte(semVer.minor,2)` | + | | | `lt` | `?filter=lt(semVer.minor,2)` | + | | | `lte` | `?filter=lte(semVer.minor,2)` | + | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | + | | | `neq` | `?filter=neq(semVer.patch,0)` | + | | | `gt` | `?filter=gt(semVer.patch,0)` | + | | | `gte` | `?filter=gte(semVer.patch,0)` | + | | | `lt` | `?filter=lt(semVer.patch,0)` | + | | | `lte` | `?filter=lte(semVer.patch,0)` | + | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | + | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | + | | | `has` | `?filter=has(semVer.preRelease,"be")` | + | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | + | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | + | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | + | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | + | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | + | | | `has` | `?filter=has(semVer.build,"exp.sha")` | + | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | + | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | + | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | + | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` |
- operationId: listTrustFrameworkVersions + operationId: listInformationStandardVersions security: - oauth2: - - trust-frameworks:read + - information-standards:read tags: - - trust-framework-versions + - information-standard-versions parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/skip' @@ -4088,7 +4172,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' headers: Total-Count: $ref: '#/components/headers/Total-Count' @@ -4107,21 +4191,517 @@ paths: 5XX: $ref: '#/components/responses/InternalError' post: - summary: Add a trust framework version + summary: Add an information standard version description: | - Adds a trust framework version to the collection. - operationId: addTrustFrameworkVersion + Adds an information standard version to the collection. + operationId: addInformationStandardVersion security: - oauth2: - - trust-frameworks:write + - information-standards:write tags: - - trust-framework-versions + - information-standard-versions requestBody: - description: Trust framework version object to add + description: Information standard version object to add content: application/json: schema: - $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /information-standard-versions/{informationStandardVersionId}: + get: + summary: Get an information standard version by ID + description: | + Returns a single information standard version. + operationId: getInformationStandardVersionById + security: + - oauth2: + - information-standards:read + tags: + - information-standard-versions + parameters: + - $ref: '#/components/parameters/informationStandardVersionId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + patch: + summary: Update an information standard version + description: | + Updates a single information standard version. + operationId: updateInformationStandardVersion + security: + - oauth2: + - information-standards:write + tags: + - information-standard-versions + parameters: + - $ref: '#/components/parameters/informationStandardVersionId' + requestBody: + description: Updated information standard version object + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_Update' + responses: + '200': + description: Updated + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /trust-frameworks: + get: + summary: List all trust frameworks + description: |- + Returns a list of trust frameworks. + +
+ Details + + ## Sort expressions + + The following table lists the field names and directions you can use in a sort expression. + + | Field | Type | Direction | Example | + |---------------------|-------------|-----------|---------------------------------| + | `id` | `uuid` | `asc` | `?sort=asc(id)` | + | | | `desc` | `?sort=desc(id)` | + | `name` | `string` | `asc` | `?sort=asc(name)` | + | | | `desc` | `?sort=desc(name)` | + | `createTime` | `date-time` | `asc` | `?sort=asc(createTime)` | + | | | `desc` | `?sort=desc(createTime)` | + | `updateTime` | `date-time` | `asc` | `?sort=asc(updateTime)` | + | | | `desc` | `?sort=desc(updateTime)` | + + ### Default sort expression + + If the `sort` parameter is omitted, the default sort expression is used: + + ``` + ?sort=desc(createTime) + ``` + + This causes results to be sorted by `createTime` in descending order (from most recent to oldest). + + ## Filter expressions + + The following table lists the field names and operators you can use in a filter expression. + + | Field | Type | Operator | Example | + |------------------------------|-------------------------|----------|----------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"MedMij Afsprakenstelsel")` | + | | | `neq` | `?filter=neq(name,"MedMij Afsprakenstelsel")` | + | | | `has` | `?filter=has(name,"MedMij")` | + | | | `stw` | `?filter=stw(name,"MedMij")` | + | | | `enw` | `?filter=enw(name,"Afsprakenstelsel")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"MedMij Afsprakenstelsel")` | + | | | `neq` | `?filter=neq(description,"MedMij Afsprakenstelsel")` | + | | | `has` | `?filter=has(description,"MedMij")` | + | | | `stw` | `?filter=stw(description,"MedMij")` | + | | | `enw` | `?filter=enw(description,"Afsprakenstelsel")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + +
+ operationId: listTrustFrameworks + security: + - oauth2: + - trust-frameworks:read + tags: + - trust-frameworks + parameters: + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/sort' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' + responses: + '200': + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrustFramework_Read' + headers: + Total-Count: + $ref: '#/components/headers/Total-Count' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + post: + summary: Add a trust framework + description: | + Adds a trust framework to the collection. + operationId: addTrustFramework + security: + - oauth2: + - trust-frameworks:write + tags: + - trust-frameworks + requestBody: + description: Trust framework object to add + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Create' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Create_Response' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /trust-frameworks/{trustFrameworkId}: + get: + summary: Get a trust framework by ID + description: | + Returns a single trust framework. + operationId: getTrustFrameworkById + security: + - oauth2: + - trust-frameworks:read + tags: + - trust-frameworks + parameters: + - $ref: '#/components/parameters/trustFrameworkId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Read' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + patch: + summary: Update a trust framework + description: | + Updates a single trust framework. + operationId: updateTrustFramework + security: + - oauth2: + - trust-frameworks:write + tags: + - trust-frameworks + parameters: + - $ref: '#/components/parameters/trustFrameworkId' + requestBody: + description: Updated trust framework object + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Update' + responses: + '200': + description: Updated + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Read' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /trust-framework-versions: + get: + summary: List all trust framework versions + description: |- + Returns a list of trust framework versions. + +
+ Details + + ## Sort expressions + + The following table lists the field names and directions you can use in a sort expression. + + | Field | Type | Direction | Example | + |---------------------|-------------|-----------|---------------------------------| + | `id` | `uuid` | `asc` | `?sort=asc(id)` | + | | | `desc` | `?sort=desc(id)` | + | `name` | `string` | `asc` | `?sort=asc(name)` | + | | | `desc` | `?sort=desc(name)` | + | `publishTime` | `date-time` | `asc` | `?sort=asc(publishTime)` | + | | | `desc` | `?sort=desc(publishTime)` | + | `semVer.major` | `integer` | `asc` | `?sort=asc(semVer.major)` | + | | | `desc` | `?sort=desc(semVer.major)` | + | `semVer.minor` | `integer` | `asc` | `?sort=asc(semVer.minor)` | + | | | `desc` | `?sort=desc(semVer.minor)` | + | `semVer.patch` | `integer` | `asc` | `?sort=asc(semVer.patch)` | + | | | `desc` | `?sort=desc(semVer.patch)` | + | `semVer.preRelease` | `string` | `asc` | `?sort=asc(semVer.preRelease)` | + | | | `desc` | `?sort=desc(semVer.preRelease)` | + | `semVer.build` | `string` | `asc` | `?sort=asc(semVer.build)` | + | | | `desc` | `?sort=desc(semVer.build)` | + | `createTime` | `date-time` | `asc` | `?sort=asc(createTime)` | + | | | `desc` | `?sort=desc(createTime)` | + | `updateTime` | `date-time` | `asc` | `?sort=asc(updateTime)` | + | | | `desc` | `?sort=desc(updateTime)` | + + ### Default sort expression + + If the `sort` parameter is omitted, the default sort expression is used: + + ``` + ?sort=desc(publishTime) + ``` + + This causes results to be sorted by `publishTime` in descending order (from most recent to oldest). + + ## Filter expressions + + The following table lists the field names and operators you can use in a filter expression. + + | Field | Type | Operator | Example | + |---------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | + | | | `neq` | `?filter=neq(name,"1.2.0")` | + | | | `has` | `?filter=has(name,"1.2")` | + | | | `stw` | `?filter=stw(name,"1.2")` | + | | | `enw` | `?filter=enw(name,"2.0")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | + | | | `neq` | `?filter=neq(description,"1.2.0")` | + | | | `has` | `?filter=has(description,"1.2")` | + | | | `stw` | `?filter=stw(description,"1.2")` | + | | | `enw` | `?filter=enw(description,"2.0")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `trustFrameworkId` | `uuid` | `eq` | `?filter=eq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | + | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | + | | | `neq` | `?filter=neq(semVer.major,1)` | + | | | `gt` | `?filter=gt(semVer.major,1)` | + | | | `gte` | `?filter=gte(semVer.major,1)` | + | | | `lt` | `?filter=lt(semVer.major,1)` | + | | | `lte` | `?filter=lte(semVer.major,1)` | + | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | + | | | `neq` | `?filter=neq(semVer.minor,2)` | + | | | `gt` | `?filter=gt(semVer.minor,2)` | + | | | `gte` | `?filter=gte(semVer.minor,2)` | + | | | `lt` | `?filter=lt(semVer.minor,2)` | + | | | `lte` | `?filter=lte(semVer.minor,2)` | + | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | + | | | `neq` | `?filter=neq(semVer.patch,0)` | + | | | `gt` | `?filter=gt(semVer.patch,0)` | + | | | `gte` | `?filter=gte(semVer.patch,0)` | + | | | `lt` | `?filter=lt(semVer.patch,0)` | + | | | `lte` | `?filter=lte(semVer.patch,0)` | + | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | + | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | + | | | `has` | `?filter=has(semVer.preRelease,"be")` | + | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | + | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | + | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | + | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | + | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | + | | | `has` | `?filter=has(semVer.build,"exp.sha")` | + | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | + | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | + | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | + | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + +
+ operationId: listTrustFrameworkVersions + security: + - oauth2: + - trust-frameworks:read + tags: + - trust-framework-versions + parameters: + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/sort' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' + responses: + '200': + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' + headers: + Total-Count: + $ref: '#/components/headers/Total-Count' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + post: + summary: Add a trust framework version + description: | + Adds a trust framework version to the collection. + operationId: addTrustFrameworkVersion + security: + - oauth2: + - trust-frameworks:write + tags: + - trust-framework-versions + requestBody: + description: Trust framework version object to add + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' responses: '201': description: Created @@ -5853,196 +6433,11 @@ components: type: string maxLength: 1000 examples: - - https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens - BasicApiSpecificationVersionUrl: - allOf: - - $ref: '#/components/schemas/ApiSpecificationVersionUrl' - - description: The basic API specification version URL information - ApiRankingLevel: - type: string - enum: - - NONE - - OPEN_API - - TECHNICALLY_STANDARDIZED_API - - FULLY_STANDARDIZED_API - description: | - The API ranking level: - - - `NONE` - None. - - `OPEN_API` - Open API. - - `TECHNICALLY_STANDARDIZED_API` - Technically standardized API. - - `FULLY_STANDARDIZED_API` - Fully standardized API. - examples: - - OPEN_API - ApiRanking: - description: The API ranking information - type: object - required: - - score - - maximumScore - properties: - score: - description: The API ranking score - type: integer - format: int32 - minimum: 0 - examples: - - 27 - maximumScore: - description: The API ranking maximum score - type: integer - format: int32 - minimum: 0 - examples: - - 31 - ApiSpecificationVersionDeclarationOfConformity: - description: The API specification version declaration of conformity information - type: object - required: - - requirementsVersion - - id - - rankingLevel - - rankings - properties: - id: - description: The ID of the API specification version declaration of conformity - type: string - format: uuid - readOnly: true - examples: - - 188c9c2c-ea9e-48fa-8423-5e8e2f60161c - requirementsVersion: - description: The name of the API requirements version - type: string - maxLength: 255 - examples: - - 1.2.0 - rankingLevel: - description: The API specification version ranking level - readOnly: true - allOf: - - $ref: '#/components/schemas/ApiRankingLevel' - examples: - - OPEN_API - rankings: - description: | - A string-to-object map where keys are strings of `ApiRankingType` and values are objects of `ApiRanking` - readOnly: true - type: object - additionalProperties: - $ref: '#/components/schemas/ApiRanking' - examples: - - OPEN_API: - score: 27 - maximumScore: 31 - TECHNICALLY_STANDARDIZED_API: - score: 6 - maximumScore: 11 - FULLY_STANDARDIZED_API: - score: 2 - maximumScore: 6 - BasicApiSpecificationVersionDeclarationOfConformity: - allOf: - - $ref: '#/components/schemas/ApiSpecificationVersionDeclarationOfConformity' - - description: The basic API specification version declaration of conformity information - BasicApiSpecificationVersion: - allOf: - - $ref: '#/components/schemas/ApiSpecificationVersion' - - description: The basic API specification version information - type: object - required: - - urls - - lastDeclarationOfConformity - properties: - urls: - type: array - items: - $ref: '#/components/schemas/BasicApiSpecificationVersionUrl' - lastDeclarationOfConformity: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicApiSpecificationVersionDeclarationOfConformity' - ApiSpecification_Read: - allOf: - - $ref: '#/components/schemas/ApiSpecification' - - type: object - required: - - organizationId - - architecturalStyle - properties: - organizationId: - description: The ID of the organization that maintains the API specification - type: string - format: uuid - examples: - - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - organization: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicOrganization' - examples: - - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - name: Stichting MedMij - architecturalStyle: - description: The architectural style of the API specification - allOf: - - $ref: '#/components/schemas/ApiArchitecturalStyle' - examples: - - REST - mainVersionId: - description: The ID of the main version of the API specification - type: - - string - - 'null' - format: uuid - examples: - - 15261fd0-b292-45d9-b6b1-266cc922fb50 - mainVersion: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicApiSpecificationVersion' - - $ref: '#/components/schemas/BasicResponse' - ApiSpecification_Create: - allOf: - - $ref: '#/components/schemas/ApiSpecification' - - type: object - required: - - organizationId - - architecturalStyle - properties: - organizationId: - description: The ID of the organization that maintains the API specification - type: string - format: uuid - examples: - - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - organization: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicOrganization' - examples: - - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - name: Stichting MedMij - architecturalStyle: - description: The architectural style of the API specification - allOf: - - $ref: '#/components/schemas/ApiArchitecturalStyle' - examples: - - REST - - $ref: '#/components/schemas/BasicResponse' - ApiSpecification_Update: + - https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens + BasicApiSpecificationVersionUrl: allOf: - - $ref: '#/components/schemas/ApiSpecification' - - type: object - properties: - mainVersionId: - description: The ID of the main version of the API specification - type: - - string - - 'null' - format: uuid - examples: - - 15261fd0-b292-45d9-b6b1-266cc922fb50 + - $ref: '#/components/schemas/ApiSpecificationVersionUrl' + - description: The basic API specification version URL information BasicCommunicationStandard: description: The basic communication standard information type: object @@ -6098,6 +6493,61 @@ components: examples: - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 name: FHIR + BasicInformationStandard: + description: The basic information standard information + type: object + required: + - name + - id + properties: + id: + description: The ID of the information standard + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: + description: The name of the information standard + type: string + maxLength: 255 + examples: + - FHIR + BasicInformationStandardVersion: + description: The basic information standard version information + type: object + required: + - id + - name + - informationStandardId + properties: + id: + description: The ID of the information standard version + type: string + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + name: + description: The name of the information standard version + type: string + maxLength: 255 + readOnly: true + examples: + - R5 + informationStandardId: + description: The ID of the information standard this version belongs to + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandard: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicInformationStandard' + examples: + - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: FHIR BasicTrustFramework: description: The basic trust framework information type: object @@ -6153,6 +6603,203 @@ components: examples: - id: 3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae name: MedMij Afsprakenstelsel + ApiRankingLevel: + type: string + enum: + - NONE + - OPEN_API + - TECHNICALLY_STANDARDIZED_API + - FULLY_STANDARDIZED_API + description: | + The API ranking level: + + - `NONE` - None. + - `OPEN_API` - Open API. + - `TECHNICALLY_STANDARDIZED_API` - Technically standardized API. + - `FULLY_STANDARDIZED_API` - Fully standardized API. + examples: + - OPEN_API + ApiRanking: + description: The API ranking information + type: object + required: + - score + - maximumScore + properties: + score: + description: The API ranking score + type: integer + format: int32 + minimum: 0 + examples: + - 27 + maximumScore: + description: The API ranking maximum score + type: integer + format: int32 + minimum: 0 + examples: + - 31 + ApiSpecificationVersionDeclarationOfConformity: + description: The API specification version declaration of conformity information + type: object + required: + - requirementsVersion + - id + - rankingLevel + - rankings + properties: + id: + description: The ID of the API specification version declaration of conformity + type: string + format: uuid + readOnly: true + examples: + - 188c9c2c-ea9e-48fa-8423-5e8e2f60161c + requirementsVersion: + description: The name of the API requirements version + type: string + maxLength: 255 + examples: + - 1.2.0 + rankingLevel: + description: The API specification version ranking level + readOnly: true + allOf: + - $ref: '#/components/schemas/ApiRankingLevel' + examples: + - OPEN_API + rankings: + description: | + A string-to-object map where keys are strings of `ApiRankingType` and values are objects of `ApiRanking` + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/ApiRanking' + examples: + - OPEN_API: + score: 27 + maximumScore: 31 + TECHNICALLY_STANDARDIZED_API: + score: 6 + maximumScore: 11 + FULLY_STANDARDIZED_API: + score: 2 + maximumScore: 6 + BasicApiSpecificationVersionDeclarationOfConformity: + allOf: + - $ref: '#/components/schemas/ApiSpecificationVersionDeclarationOfConformity' + - description: The basic API specification version declaration of conformity information + BasicApiSpecificationVersion: + allOf: + - $ref: '#/components/schemas/ApiSpecificationVersion' + - description: The basic API specification version information + type: object + required: + - urls + - lastDeclarationOfConformity + properties: + urls: + type: array + items: + $ref: '#/components/schemas/BasicApiSpecificationVersionUrl' + communicationStandardVersions: + type: array + items: + $ref: '#/components/schemas/BasicCommunicationStandardVersion' + informationStandardVersions: + type: array + items: + $ref: '#/components/schemas/BasicInformationStandardVersion' + trustFrameworkVersions: + type: array + items: + $ref: '#/components/schemas/BasicTrustFrameworkVersion' + lastDeclarationOfConformity: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicApiSpecificationVersionDeclarationOfConformity' + ApiSpecification_Read: + allOf: + - $ref: '#/components/schemas/ApiSpecification' + - type: object + required: + - organizationId + - architecturalStyle + properties: + organizationId: + description: The ID of the organization that maintains the API specification + type: string + format: uuid + examples: + - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + organization: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicOrganization' + examples: + - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + name: Stichting MedMij + architecturalStyle: + description: The architectural style of the API specification + allOf: + - $ref: '#/components/schemas/ApiArchitecturalStyle' + examples: + - REST + mainVersionId: + description: The ID of the main version of the API specification + type: + - string + - 'null' + format: uuid + examples: + - 15261fd0-b292-45d9-b6b1-266cc922fb50 + mainVersion: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicApiSpecificationVersion' + - $ref: '#/components/schemas/BasicResponse' + ApiSpecification_Create: + allOf: + - $ref: '#/components/schemas/ApiSpecification' + - type: object + required: + - organizationId + - architecturalStyle + properties: + organizationId: + description: The ID of the organization that maintains the API specification + type: string + format: uuid + examples: + - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + organization: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicOrganization' + examples: + - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + name: Stichting MedMij + architecturalStyle: + description: The architectural style of the API specification + allOf: + - $ref: '#/components/schemas/ApiArchitecturalStyle' + examples: + - REST + - $ref: '#/components/schemas/BasicResponse' + ApiSpecification_Update: + allOf: + - $ref: '#/components/schemas/ApiSpecification' + - type: object + properties: + mainVersionId: + description: The ID of the main version of the API specification + type: + - string + - 'null' + format: uuid + examples: + - 15261fd0-b292-45d9-b6b1-266cc922fb50 ApiSpecificationVersion_CreateRead: allOf: - $ref: '#/components/schemas/ApiSpecificationVersion' @@ -6168,6 +6815,10 @@ components: type: array items: $ref: '#/components/schemas/BasicCommunicationStandardVersion' + informationStandardVersions: + type: array + items: + $ref: '#/components/schemas/BasicInformationStandardVersion' trustFrameworkVersions: type: array items: @@ -6427,6 +7078,189 @@ components: properties: communicationStandardId: readOnly: true + InformationStandardVersion: + description: The information standard version information + type: object + required: + - name + - informationStandardId + - publishTime + - semVer + - lifecycleState + - id + properties: + id: + description: The ID of the information standard version + type: string + format: uuid + readOnly: true + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + name: + description: The name of the information standard version + type: string + maxLength: 255 + examples: + - R5 + description: + description: The description of the information standard version + type: + - string + - 'null' + maxLength: 1000 + examples: + - FHIR Specification 5.0.0 + informationStandardId: + description: The ID of the information standard this version belongs to + type: string + format: uuid + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandard: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicInformationStandard' + examples: + - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: FHIR + publishTime: + description: The date and time at which the information standard version was published + type: string + format: date-time + examples: + - '2023-03-26T12:00:00.0000000Z' + semVer: + allOf: + - $ref: '#/components/schemas/SemVer' + examples: + - major: 5 + minor: 0 + patch: 0 + lifecycleState: + description: The lifecycle state of the information standard version + allOf: + - $ref: '#/components/schemas/ProductLifecycleState' + examples: + - PUBLISHED + url: + description: The URL of the information standard version + type: + - string + - 'null' + maxLength: 1000 + examples: + - https://hl7.org/fhir/R5 + MainInformationStandardVersion: + allOf: + - $ref: '#/components/schemas/InformationStandardVersion' + - type: object + properties: + informationStandardId: + writeOnly: true + informationStandard: + writeOnly: true + InformationStandard: + description: The information standard information + type: object + required: + - name + - organizationId + - url + - id + properties: + id: + description: The ID of the information standard + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: + description: The name of the information standard + type: string + maxLength: 255 + examples: + - FHIR + description: + description: The description of the information standard + type: + - string + - 'null' + maxLength: 1000 + examples: + - FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability. + organizationId: + description: The ID of the organization that maintains the information standard + type: string + format: uuid + examples: + - a70590c6-06ce-4dba-9098-ed996335bdec + organization: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicOrganization' + examples: + - id: a70590c6-06ce-4dba-9098-ed996335bdec + name: HL7 Nederland + url: + description: The URL of the information standard + type: string + maxLength: 1000 + examples: + - https://hl7.org/fhir/ + mainVersionId: + description: The ID of the main version of the information standard + type: + - string + - 'null' + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + mainVersion: + readOnly: true + allOf: + - $ref: '#/components/schemas/MainInformationStandardVersion' + InformationStandard_Read: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - $ref: '#/components/schemas/BasicResponse' + InformationStandard_Create: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - type: object + properties: + mainVersionId: + readOnly: true + - $ref: '#/components/schemas/BasicResponse' + InformationStandard_Create_Response: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - type: object + properties: + mainVersionId: + writeOnly: true + mainVersion: + readOnly: false + writeOnly: true + - $ref: '#/components/schemas/BasicResponse' + InformationStandard_Update: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - type: object + properties: + organizationId: + readOnly: true + InformationStandardVersion_CreateRead: + allOf: + - $ref: '#/components/schemas/InformationStandardVersion' + - $ref: '#/components/schemas/BasicResponse' + InformationStandardVersion_Update: + allOf: + - $ref: '#/components/schemas/InformationStandardVersion' + - type: object + properties: + informationStandardId: + readOnly: true TrustFrameworkVersion: description: The trust framework version information type: object @@ -7074,6 +7908,16 @@ components: format: uuid examples: - 8ae84d7f-73e7-4f08-b839-c73c97128ada + informationStandardVersionId: + name: informationStandardVersionId + in: path + required: true + description: The ID of the information standard version + schema: + type: string + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada trustFrameworkVersionId: name: trustFrameworkVersionId in: path @@ -7094,6 +7938,16 @@ components: format: uuid examples: - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandardId: + name: informationStandardId + in: path + required: true + description: The ID of the information standard + schema: + type: string + format: uuid + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 trustFrameworkId: name: trustFrameworkId in: path @@ -7281,11 +8135,16 @@ x-tagGroups: - api-specifications.versions.urls - api-specifications.versions.declarations-of-conformity - api-specifications.versions.communication-standard-versions + - api-specifications.versions.information-standard-versions - api-specifications.versions.trust-framework-versions - name: Communication standards tags: - communication-standards - communication-standard-versions + - name: Information standards + tags: + - information-standards + - information-standard-versions - name: Trust frameworks tags: - trust-frameworks diff --git a/src/v1beta1/_parameters.yaml b/src/v1beta1/_parameters.yaml index 19c9d4f..8c58656 100644 --- a/src/v1beta1/_parameters.yaml +++ b/src/v1beta1/_parameters.yaml @@ -47,6 +47,16 @@ communicationStandardId: communicationStandardVersionId: $ref: './communication-standard-versions/_parameters/path/communicationStandardVersionId.yaml' +# information-standards +# path +informationStandardId: + $ref: './information-standards/_parameters/path/informationStandardId.yaml' + +# information-standard-versions +# path +informationStandardVersionId: + $ref: './information-standard-versions/_parameters/path/informationStandardVersionId.yaml' + # trust-frameworks # path trustFrameworkId: diff --git a/src/v1beta1/_schemas.yaml b/src/v1beta1/_schemas.yaml index 50b21fa..6eee1c7 100644 --- a/src/v1beta1/_schemas.yaml +++ b/src/v1beta1/_schemas.yaml @@ -164,6 +164,32 @@ BasicCommunicationStandardVersion: MainCommunicationStandardVersion: $ref: './communication-standard-versions/_schemas/MainCommunicationStandardVersion.yaml' +# information-standards +InformationStandard: + $ref: './information-standards/_schemas/InformationStandard.yaml' +InformationStandard_Create: + $ref: './information-standards/_schemas/InformationStandard_Create.yaml' +InformationStandard_Create_Response: + $ref: './information-standards/_schemas/InformationStandard_Create_Response.yaml' +InformationStandard_Read: + $ref: './information-standards/_schemas/InformationStandard_Read.yaml' +InformationStandard_Update: + $ref: './information-standards/_schemas/InformationStandard_Update.yaml' +BasicInformationStandard: + $ref: './information-standards/_schemas/BasicInformationStandard.yaml' + +# information-standard-versions +InformationStandardVersion: + $ref: './information-standard-versions/_schemas/InformationStandardVersion.yaml' +InformationStandardVersion_CreateRead: + $ref: './information-standard-versions/_schemas/InformationStandardVersion_CreateRead.yaml' +InformationStandardVersion_Update: + $ref: './information-standard-versions/_schemas/InformationStandardVersion_Update.yaml' +BasicInformationStandardVersion: + $ref: './information-standard-versions/_schemas/BasicInformationStandardVersion.yaml' +MainInformationStandardVersion: + $ref: './information-standard-versions/_schemas/MainInformationStandardVersion.yaml' + # trust-frameworks TrustFramework: $ref: './trust-frameworks/_schemas/TrustFramework.yaml' diff --git a/src/v1beta1/api-specifications/_paths/api-specifications#description.md b/src/v1beta1/api-specifications/_paths/api-specifications#description.md index 9f863f1..f869f49 100644 --- a/src/v1beta1/api-specifications/_paths/api-specifications#description.md +++ b/src/v1beta1/api-specifications/_paths/api-specifications#description.md @@ -50,6 +50,10 @@ The following table lists the field names and operators you can use in a filter | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `mainVersion.informationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.informationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(mainVersion.informationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `mainVersion.informationStandardVersions.$it.informationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.informationStandardVersions,eq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(mainVersion.informationStandardVersions,neq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(mainVersion.trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | diff --git a/src/v1beta1/api-specifications/versions/_paths/versions#description.md b/src/v1beta1/api-specifications/versions/_paths/versions#description.md index 7decada..49e65f4 100644 --- a/src/v1beta1/api-specifications/versions/_paths/versions#description.md +++ b/src/v1beta1/api-specifications/versions/_paths/versions#description.md @@ -96,6 +96,10 @@ The following table lists the field names and operators you can use in a filter | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `informationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(informationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `informationStandardVersions.$it.informationStandardId` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(informationStandardVersions,neq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | diff --git a/src/v1beta1/api-specifications/versions/_schemas/ApiSpecificationVersion_CreateRead.yaml b/src/v1beta1/api-specifications/versions/_schemas/ApiSpecificationVersion_CreateRead.yaml index c7b6fab..60213ce 100644 --- a/src/v1beta1/api-specifications/versions/_schemas/ApiSpecificationVersion_CreateRead.yaml +++ b/src/v1beta1/api-specifications/versions/_schemas/ApiSpecificationVersion_CreateRead.yaml @@ -15,6 +15,10 @@ allOf: type: array items: $ref: '../../../communication-standard-versions/_schemas/BasicCommunicationStandardVersion.yaml' + informationStandardVersions: + type: array + items: + $ref: '../../../information-standard-versions/_schemas/BasicInformationStandardVersion.yaml' trustFrameworkVersions: type: array items: diff --git a/src/v1beta1/api-specifications/versions/_schemas/BasicApiSpecificationVersion.yaml b/src/v1beta1/api-specifications/versions/_schemas/BasicApiSpecificationVersion.yaml index a479f30..8207cf5 100644 --- a/src/v1beta1/api-specifications/versions/_schemas/BasicApiSpecificationVersion.yaml +++ b/src/v1beta1/api-specifications/versions/_schemas/BasicApiSpecificationVersion.yaml @@ -13,6 +13,18 @@ allOf: type: array items: $ref: '../urls/_schemas/BasicApiSpecificationVersionUrl.yaml' + communicationStandardVersions: + type: array + items: + $ref: '../../../communication-standard-versions/_schemas/BasicCommunicationStandardVersion.yaml' + informationStandardVersions: + type: array + items: + $ref: '../../../information-standard-versions/_schemas/BasicInformationStandardVersion.yaml' + trustFrameworkVersions: + type: array + items: + $ref: '../../../trust-framework-versions/_schemas/BasicTrustFrameworkVersion.yaml' lastDeclarationOfConformity: # Returned by GET, not used in POST/PUT/PATCH readOnly: true diff --git a/src/v1beta1/api-specifications/versions/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml b/src/v1beta1/api-specifications/versions/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml new file mode 100644 index 0000000..0688d7f --- /dev/null +++ b/src/v1beta1/api-specifications/versions/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml @@ -0,0 +1,66 @@ +put: + summary: Set an information standard version for an API specification version + description: | + Sets a single information standard version for an API specification version. + operationId: setApiSpecificationVersionInformationStandardVersion + security: + - oauth2: + - api-specifications:write + tags: + - api-specifications.versions.information-standard-versions + parameters: + - $ref: '../../../_parameters/path/apiSpecificationId.yaml' + - $ref: '../../../../_parameters/path/versionId.yaml' + - $ref: '../../../../information-standard-versions/_parameters/path/informationStandardVersionId.yaml' + responses: + '204': + $ref: '../../../../_responses/EmptyResponse.yaml' + '400': + $ref: '../../../../_responses/BadRequestError.yaml' + '401': + $ref: '../../../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../../../_responses/PermissionDeniedError.yaml' + '404': + $ref: '../../../../_responses/NotFoundError.yaml' + '422': + $ref: '../../../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../../../_responses/UnavailableError.yaml' + 5XX: + $ref: '../../../../_responses/InternalError.yaml' +delete: + summary: Delete an information standard version from an API specification version + description: | + Deletes a single information standard version from an API specification version. + operationId: deleteApiSpecificationVersionInformationStandardVersion + security: + - oauth2: + - api-specifications:write + tags: + - api-specifications.versions.information-standard-versions + parameters: + - $ref: '../../../_parameters/path/apiSpecificationId.yaml' + - $ref: '../../../../_parameters/path/versionId.yaml' + - $ref: '../../../../information-standard-versions/_parameters/path/informationStandardVersionId.yaml' + responses: + '204': + $ref: '../../../../_responses/EmptyResponse.yaml' + '400': + $ref: '../../../../_responses/BadRequestError.yaml' + '401': + $ref: '../../../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../../../_responses/PermissionDeniedError.yaml' + '404': + $ref: '../../../../_responses/NotFoundError.yaml' + '422': + $ref: '../../../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../../../_responses/UnavailableError.yaml' + 5XX: + $ref: '../../../../_responses/InternalError.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml b/src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml new file mode 100644 index 0000000..8b32098 --- /dev/null +++ b/src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml @@ -0,0 +1,9 @@ +name: informationStandardVersionId +in: path +required: true +description: The ID of the information standard version +schema: + type: string + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada diff --git a/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md b/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md new file mode 100644 index 0000000..344163a --- /dev/null +++ b/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md @@ -0,0 +1,116 @@ +Returns a list of information standard versions. + +
+Details + +## Sort expressions + +The following table lists the field names and directions you can use in a sort expression. + +| Field | Type | Direction | Example | +|---------------------|-------------|-----------|---------------------------------| +| `id` | `uuid` | `asc` | `?sort=asc(id)` | +| | | `desc` | `?sort=desc(id)` | +| `name` | `string` | `asc` | `?sort=asc(name)` | +| | | `desc` | `?sort=desc(name)` | +| `publishTime` | `date-time` | `asc` | `?sort=asc(publishTime)` | +| | | `desc` | `?sort=desc(publishTime)` | +| `semVer.major` | `integer` | `asc` | `?sort=asc(semVer.major)` | +| | | `desc` | `?sort=desc(semVer.major)` | +| `semVer.minor` | `integer` | `asc` | `?sort=asc(semVer.minor)` | +| | | `desc` | `?sort=desc(semVer.minor)` | +| `semVer.patch` | `integer` | `asc` | `?sort=asc(semVer.patch)` | +| | | `desc` | `?sort=desc(semVer.patch)` | +| `semVer.preRelease` | `string` | `asc` | `?sort=asc(semVer.preRelease)` | +| | | `desc` | `?sort=desc(semVer.preRelease)` | +| `semVer.build` | `string` | `asc` | `?sort=asc(semVer.build)` | +| | | `desc` | `?sort=desc(semVer.build)` | +| `createTime` | `date-time` | `asc` | `?sort=asc(createTime)` | +| | | `desc` | `?sort=desc(createTime)` | +| `updateTime` | `date-time` | `asc` | `?sort=asc(updateTime)` | +| | | `desc` | `?sort=desc(updateTime)` | + +### Default sort expression + +If the `sort` parameter is omitted, the default sort expression is used: + +``` +?sort=desc(publishTime) +``` + +This causes results to be sorted by `publishTime` in descending order (from most recent to oldest). + +## Filter expressions + +The following table lists the field names and operators you can use in a filter expression. + +| Field | Type | Operator | Example | +|---------------------------|-------------------------|----------|-------------------------------------------------------------------------------| +| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | +| | | `neq` | `?filter=neq(name,"1.2.0")` | +| | | `has` | `?filter=has(name,"1.2")` | +| | | `stw` | `?filter=stw(name,"1.2")` | +| | | `enw` | `?filter=enw(name,"2.0")` | +| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | +| `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | +| | | `neq` | `?filter=neq(description,"1.2.0")` | +| | | `has` | `?filter=has(description,"1.2")` | +| | | `stw` | `?filter=stw(description,"1.2")` | +| | | `enw` | `?filter=enw(description,"2.0")` | +| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | +| `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | +| `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | +| | | `neq` | `?filter=neq(semVer.major,1)` | +| | | `gt` | `?filter=gt(semVer.major,1)` | +| | | `gte` | `?filter=gte(semVer.major,1)` | +| | | `lt` | `?filter=lt(semVer.major,1)` | +| | | `lte` | `?filter=lte(semVer.major,1)` | +| `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | +| | | `neq` | `?filter=neq(semVer.minor,2)` | +| | | `gt` | `?filter=gt(semVer.minor,2)` | +| | | `gte` | `?filter=gte(semVer.minor,2)` | +| | | `lt` | `?filter=lt(semVer.minor,2)` | +| | | `lte` | `?filter=lte(semVer.minor,2)` | +| `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | +| | | `neq` | `?filter=neq(semVer.patch,0)` | +| | | `gt` | `?filter=gt(semVer.patch,0)` | +| | | `gte` | `?filter=gte(semVer.patch,0)` | +| | | `lt` | `?filter=lt(semVer.patch,0)` | +| | | `lte` | `?filter=lte(semVer.patch,0)` | +| `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | +| | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | +| | | `has` | `?filter=has(semVer.preRelease,"be")` | +| | | `stw` | `?filter=stw(semVer.preRelease,"be")` | +| | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | +| | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | +| `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | +| | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | +| | | `has` | `?filter=has(semVer.build,"exp.sha")` | +| | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | +| | | `enw` | `?filter=enw(semVer.build,"5114f85")` | +| | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | +| `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | +| | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | +| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | +| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + +
\ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_paths/information-standard-versions.yaml b/src/v1beta1/information-standard-versions/_paths/information-standard-versions.yaml new file mode 100644 index 0000000..6f00b75 --- /dev/null +++ b/src/v1beta1/information-standard-versions/_paths/information-standard-versions.yaml @@ -0,0 +1,78 @@ +get: + summary: List all information standard versions + description: + $ref: './information-standard-versions#description.md' + operationId: listInformationStandardVersions + security: + - oauth2: + - information-standards:read + tags: + - information-standard-versions + parameters: + - $ref: '../../_parameters/query/limit.yaml' + - $ref: '../../_parameters/query/skip.yaml' + - $ref: '../../_parameters/query/sort.yaml' + - $ref: '../../_parameters/query/filter.yaml' + - $ref: '../../_parameters/query/count.yaml' + responses: + '200': + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '../_schemas/InformationStandardVersion_CreateRead.yaml' + headers: + $ref: '../../_headers/defaultListHeaders.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + '5XX': + $ref: '../../_responses/InternalError.yaml' +post: + summary: Add an information standard version + description: | + Adds an information standard version to the collection. + operationId: addInformationStandardVersion + security: + - oauth2: + - information-standards:write + tags: + - information-standard-versions + requestBody: + description: Information standard version object to add + content: + application/json: + schema: + $ref: '../_schemas/InformationStandardVersion_CreateRead.yaml' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '../_schemas/InformationStandardVersion_CreateRead.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + '5XX': + $ref: '../../_responses/InternalError.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml b/src/v1beta1/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml new file mode 100644 index 0000000..fdd4821 --- /dev/null +++ b/src/v1beta1/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml @@ -0,0 +1,76 @@ +get: + summary: Get an information standard version by ID + description: | + Returns a single information standard version. + operationId: getInformationStandardVersionById + security: + - oauth2: + - information-standards:read + tags: + - information-standard-versions + parameters: + - $ref: '../_parameters/path/informationStandardVersionId.yaml' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '../_schemas/InformationStandardVersion_CreateRead.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '404': + $ref: '../../_responses/NotFoundError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + 5XX: + $ref: '../../_responses/InternalError.yaml' +patch: + summary: Update an information standard version + description: | + Updates a single information standard version. + operationId: updateInformationStandardVersion + security: + - oauth2: + - information-standards:write + tags: + - information-standard-versions + parameters: + - $ref: '../_parameters/path/informationStandardVersionId.yaml' + requestBody: + description: Updated information standard version object + content: + application/json: + schema: + $ref: '../_schemas/InformationStandardVersion_Update.yaml' + responses: + '200': + description: Updated + content: + application/json: + schema: + $ref: '../_schemas/InformationStandardVersion_CreateRead.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '404': + $ref: '../../_responses/NotFoundError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + 5XX: + $ref: '../../_responses/InternalError.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml b/src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml new file mode 100644 index 0000000..8c253e8 --- /dev/null +++ b/src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml @@ -0,0 +1,37 @@ +description: The basic information standard version information +type: object +required: + - id + # Read-only + - name + - informationStandardId +properties: + id: + # Returned by GET, not used in POST/PUT/PATCH + description: The ID of the information standard version + type: string + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + name: + description: The name of the information standard version + type: string + maxLength: 255 + readOnly: true + examples: + - R5 + informationStandardId: + description: The ID of the information standard this version belongs to + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandard: + # Returned by GET, not used in POST/PUT/PATCH + readOnly: true + allOf: + - $ref: '../../information-standards/_schemas/BasicInformationStandard.yaml' + examples: + - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: FHIR \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml new file mode 100644 index 0000000..85e468b --- /dev/null +++ b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml @@ -0,0 +1,75 @@ +# Abstract base schema +description: The information standard version information +type: object +required: + - name + - informationStandardId + - publishTime + - semVer + - lifecycleState + # Read-only + - id +properties: + id: + # Returned by GET, not used in POST/PUT/PATCH + description: The ID of the information standard version + type: string + format: uuid + readOnly: true + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + name: + description: The name of the information standard version + type: string + maxLength: 255 + examples: + - R5 + description: + description: The description of the information standard version + type: + - 'string' + - 'null' + maxLength: 1000 + examples: + - 'FHIR Specification 5.0.0' + informationStandardId: + description: The ID of the information standard this version belongs to + type: string + format: uuid + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandard: + # Returned by GET, not used in POST/PUT/PATCH + readOnly: true + allOf: + - $ref: '../../information-standards/_schemas/BasicInformationStandard.yaml' + examples: + - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: FHIR + publishTime: + description: The date and time at which the information standard version was published + type: string + format: date-time + examples: + - '2023-03-26T12:00:00.0000000Z' + semVer: + allOf: + - $ref: '../../_schemas/SemVer.yaml' + examples: + - major: 5 + minor: 0 + patch: 0 + lifecycleState: + description: The lifecycle state of the information standard version + allOf: + - $ref: '../../_schemas/ProductLifecycleState.yaml' + examples: + - PUBLISHED + url: + description: The URL of the information standard version + type: + - 'string' + - 'null' + maxLength: 1000 + examples: + - 'https://hl7.org/fhir/R5' \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_CreateRead.yaml b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_CreateRead.yaml new file mode 100644 index 0000000..74ba5fd --- /dev/null +++ b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_CreateRead.yaml @@ -0,0 +1,5 @@ +# Resource definition for Create, Read operations +allOf: + - $ref: './InformationStandardVersion.yaml' + # Extend + - $ref: '../../_schemas/BasicResponse.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml new file mode 100644 index 0000000..23cc88e --- /dev/null +++ b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml @@ -0,0 +1,8 @@ +# Resource definition for Update operations +allOf: + - $ref: './InformationStandardVersion.yaml' + # Extend + - type: object + properties: + informationStandardId: + readOnly: true \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/MainInformationStandardVersion.yaml b/src/v1beta1/information-standard-versions/_schemas/MainInformationStandardVersion.yaml new file mode 100644 index 0000000..141cf66 --- /dev/null +++ b/src/v1beta1/information-standard-versions/_schemas/MainInformationStandardVersion.yaml @@ -0,0 +1,9 @@ +allOf: + - $ref: './InformationStandardVersion.yaml' + # Extend + - type: object + properties: + informationStandardId: + writeOnly: true + informationStandard: + writeOnly: true \ No newline at end of file diff --git a/src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml b/src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml new file mode 100644 index 0000000..37b61f1 --- /dev/null +++ b/src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml @@ -0,0 +1,9 @@ +name: informationStandardId +in: path +required: true +description: The ID of the information standard +schema: + type: string + format: uuid + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 diff --git a/src/v1beta1/information-standards/_paths/information-standards#description.md b/src/v1beta1/information-standards/_paths/information-standards#description.md new file mode 100644 index 0000000..27db73c --- /dev/null +++ b/src/v1beta1/information-standards/_paths/information-standards#description.md @@ -0,0 +1,68 @@ +Returns a list of information standards. + +
+Details + +## Sort expressions + +The following table lists the field names and directions you can use in a sort expression. + +| Field | Type | Direction | Example | +|---------------------|-------------|-----------|---------------------------------| +| `id` | `uuid` | `asc` | `?sort=asc(id)` | +| | | `desc` | `?sort=desc(id)` | +| `name` | `string` | `asc` | `?sort=asc(name)` | +| | | `desc` | `?sort=desc(name)` | +| `createTime` | `date-time` | `asc` | `?sort=asc(createTime)` | +| | | `desc` | `?sort=desc(createTime)` | +| `updateTime` | `date-time` | `asc` | `?sort=asc(updateTime)` | +| | | `desc` | `?sort=desc(updateTime)` | + +### Default sort expression + +If the `sort` parameter is omitted, the default sort expression is used: + +``` +?sort=desc(createTime) +``` + +This causes results to be sorted by `createTime` in descending order (from most recent to oldest). + +## Filter expressions + +The following table lists the field names and operators you can use in a filter expression. + +| Field | Type | Operator | Example | +|------------------------------|-------------------------|----------|----------------------------------------------------------------------| +| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | +| | | `neq` | `?filter=neq(name,"FHIR")` | +| | | `has` | `?filter=has(name,"FH")` | +| | | `stw` | `?filter=stw(name,"FH")` | +| | | `enw` | `?filter=enw(name,"IR")` | +| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | +| `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | +| | | `neq` | `?filter=neq(description,"FHIR")` | +| | | `has` | `?filter=has(description,"FH")` | +| | | `stw` | `?filter=stw(description,"FH")` | +| | | `enw` | `?filter=enw(description,"IR")` | +| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | +| `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | +| | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | +| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | +| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + +
\ No newline at end of file diff --git a/src/v1beta1/information-standards/_paths/information-standards.yaml b/src/v1beta1/information-standards/_paths/information-standards.yaml new file mode 100644 index 0000000..12d66f4 --- /dev/null +++ b/src/v1beta1/information-standards/_paths/information-standards.yaml @@ -0,0 +1,78 @@ +get: + summary: List all information standards + description: + $ref: './information-standards#description.md' + operationId: listInformationStandards + security: + - oauth2: + - information-standards:read + tags: + - information-standards + parameters: + - $ref: '../../_parameters/query/limit.yaml' + - $ref: '../../_parameters/query/skip.yaml' + - $ref: '../../_parameters/query/sort.yaml' + - $ref: '../../_parameters/query/filter.yaml' + - $ref: '../../_parameters/query/count.yaml' + responses: + '200': + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '../_schemas/InformationStandard_Read.yaml' + headers: + $ref: '../../_headers/defaultListHeaders.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + '5XX': + $ref: '../../_responses/InternalError.yaml' +post: + summary: Add an information standard + description: | + Adds an information standard to the collection. + operationId: addInformationStandard + security: + - oauth2: + - information-standards:write + tags: + - information-standards + requestBody: + description: Information standard object to add + content: + application/json: + schema: + $ref: '../_schemas/InformationStandard_Create.yaml' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '../_schemas/InformationStandard_Create_Response.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + '5XX': + $ref: '../../_responses/InternalError.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standards/_paths/information-standards_{informationStandardId}.yaml b/src/v1beta1/information-standards/_paths/information-standards_{informationStandardId}.yaml new file mode 100644 index 0000000..4a0dd90 --- /dev/null +++ b/src/v1beta1/information-standards/_paths/information-standards_{informationStandardId}.yaml @@ -0,0 +1,76 @@ +get: + summary: Get an information standard by ID + description: | + Returns a single information standard. + operationId: getInformationStandardById + security: + - oauth2: + - information-standards:read + tags: + - information-standards + parameters: + - $ref: '../_parameters/path/informationStandardId.yaml' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '../_schemas/InformationStandard_Read.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '404': + $ref: '../../_responses/NotFoundError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + 5XX: + $ref: '../../_responses/InternalError.yaml' +patch: + summary: Update an information standard + description: | + Updates a single information standard. + operationId: updateInformationStandard + security: + - oauth2: + - information-standards:write + tags: + - information-standards + parameters: + - $ref: '../_parameters/path/informationStandardId.yaml' + requestBody: + description: Updated information standard object + content: + application/json: + schema: + $ref: '../_schemas/InformationStandard_Update.yaml' + responses: + '200': + description: Updated + content: + application/json: + schema: + $ref: '../_schemas/InformationStandard_Read.yaml' + '400': + $ref: '../../_responses/BadRequestError.yaml' + '401': + $ref: '../../_responses/UnauthenticatedError.yaml' + '403': + $ref: '../../_responses/PermissionDeniedError.yaml' + '404': + $ref: '../../_responses/NotFoundError.yaml' + '422': + $ref: '../../_responses/InvalidArgumentError.yaml' + '429': + $ref: '../../_responses/ResourceExhaustedError.yaml' + '503': + $ref: '../../_responses/UnavailableError.yaml' + 5XX: + $ref: '../../_responses/InternalError.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml b/src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml new file mode 100644 index 0000000..81c4cb8 --- /dev/null +++ b/src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml @@ -0,0 +1,21 @@ +description: The basic information standard information +type: object +required: + - name + # Read-only + - id +properties: + id: + # Returned by GET, not used in POST/PUT/PATCH + description: The ID of the information standard + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: + description: The name of the information standard + type: string + maxLength: 255 + examples: + - FHIR \ No newline at end of file diff --git a/src/v1beta1/information-standards/_schemas/InformationStandard.yaml b/src/v1beta1/information-standards/_schemas/InformationStandard.yaml new file mode 100644 index 0000000..62517bc --- /dev/null +++ b/src/v1beta1/information-standards/_schemas/InformationStandard.yaml @@ -0,0 +1,65 @@ +# Abstract base schema +description: The information standard information +type: object +required: + - name + - organizationId + - url + # Read-only + - id +properties: + id: + # Returned by GET, not used in POST/PUT/PATCH + description: The ID of the information standard + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: + description: The name of the information standard + type: string + maxLength: 255 + examples: + - FHIR + description: + description: The description of the information standard + type: + - 'string' + - 'null' + maxLength: 1000 + examples: + - 'FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.' + organizationId: + description: The ID of the organization that maintains the information standard + type: string + format: uuid + examples: + - a70590c6-06ce-4dba-9098-ed996335bdec + organization: + # Returned by GET, not used in POST/PUT/PATCH + readOnly: true + allOf: + - $ref: '../../organizations/_schemas/BasicOrganization.yaml' + examples: + - id: a70590c6-06ce-4dba-9098-ed996335bdec + name: HL7 Nederland + url: + description: The URL of the information standard + type: string + maxLength: 1000 + examples: + - 'https://hl7.org/fhir/' + mainVersionId: + description: The ID of the main version of the information standard + type: + - 'string' + - 'null' + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + mainVersion: + # Returned by GET, not used in POST/PUT/PATCH + readOnly: true + allOf: + - $ref: '../../information-standard-versions/_schemas/MainInformationStandardVersion.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standards/_schemas/InformationStandard_Create.yaml b/src/v1beta1/information-standards/_schemas/InformationStandard_Create.yaml new file mode 100644 index 0000000..de2294f --- /dev/null +++ b/src/v1beta1/information-standards/_schemas/InformationStandard_Create.yaml @@ -0,0 +1,9 @@ +# Resource definition for Create operations +allOf: + - $ref: './InformationStandard.yaml' + # Extend + - type: object + properties: + mainVersionId: + readOnly: true + - $ref: '../../_schemas/BasicResponse.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standards/_schemas/InformationStandard_Create_Response.yaml b/src/v1beta1/information-standards/_schemas/InformationStandard_Create_Response.yaml new file mode 100644 index 0000000..0519138 --- /dev/null +++ b/src/v1beta1/information-standards/_schemas/InformationStandard_Create_Response.yaml @@ -0,0 +1,12 @@ +# Resource definition for Create operations +allOf: + - $ref: './InformationStandard.yaml' + # Extend + - type: object + properties: + mainVersionId: + writeOnly: true + mainVersion: + readOnly: false + writeOnly: true + - $ref: '../../_schemas/BasicResponse.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standards/_schemas/InformationStandard_Read.yaml b/src/v1beta1/information-standards/_schemas/InformationStandard_Read.yaml new file mode 100644 index 0000000..49049a4 --- /dev/null +++ b/src/v1beta1/information-standards/_schemas/InformationStandard_Read.yaml @@ -0,0 +1,5 @@ +# Resource definition for Read operations +allOf: + - $ref: './InformationStandard.yaml' + # Extend + - $ref: '../../_schemas/BasicResponse.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standards/_schemas/InformationStandard_Update.yaml b/src/v1beta1/information-standards/_schemas/InformationStandard_Update.yaml new file mode 100644 index 0000000..ae4c097 --- /dev/null +++ b/src/v1beta1/information-standards/_schemas/InformationStandard_Update.yaml @@ -0,0 +1,8 @@ +# Resource definition for Update operations +allOf: + - $ref: './InformationStandard.yaml' + # Extend + - type: object + properties: + organizationId: + readOnly: true \ No newline at end of file diff --git a/src/v1beta1/openapi.yaml b/src/v1beta1/openapi.yaml index 462cc12..f600943 100644 --- a/src/v1beta1/openapi.yaml +++ b/src/v1beta1/openapi.yaml @@ -63,6 +63,9 @@ tags: - name: api-specifications.versions.communication-standard-versions description: API specification version communication standard versions API x-displayName: API specification version communication standard versions + - name: api-specifications.versions.information-standard-versions + description: API specification version information standard versions API + x-displayName: API specification version information standard versions - name: api-specifications.versions.trust-framework-versions description: API specification version trust framework versions API x-displayName: API specification version trust framework versions @@ -76,6 +79,16 @@ tags: - name: communication-standard-versions description: Communication standard versions API x-displayName: Communication standard versions + + # information-standards + - name: information-standards + description: Information standards API + x-displayName: Information standards + + # information-standard-versions + - name: information-standard-versions + description: Information standard versions API + x-displayName: Information standard versions # trust-frameworks - name: trust-frameworks @@ -109,11 +122,16 @@ x-tagGroups: - api-specifications.versions.urls - api-specifications.versions.declarations-of-conformity - api-specifications.versions.communication-standard-versions + - api-specifications.versions.information-standard-versions - api-specifications.versions.trust-framework-versions - name: Communication standards tags: - communication-standards - communication-standard-versions + - name: Information standards + tags: + - information-standards + - information-standard-versions - name: Trust frameworks tags: - trust-frameworks @@ -194,6 +212,9 @@ paths: # api-specifications/versions/communication-standard-versions /api-specifications/{apiSpecificationId}/versions/{versionId}/communication-standard-versions/{communicationStandardVersionId}: $ref: './api-specifications/versions/communication-standard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml' + # api-specifications/versions/information-standard-versions + /api-specifications/{apiSpecificationId}/versions/{versionId}/information-standard-versions/{informationStandardVersionId}: + $ref: './api-specifications/versions/information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml' # api-specifications/versions/trust-framework-versions /api-specifications/{apiSpecificationId}/versions/{versionId}/trust-framework-versions/{trustFrameworkVersionId}: $ref: './api-specifications/versions/trust-framework-versions/_paths/trust-framework-versions_{trustFrameworkVersionId}.yaml' @@ -209,6 +230,18 @@ paths: $ref: './communication-standard-versions/_paths/communication-standard-versions.yaml' /communication-standard-versions/{communicationStandardVersionId}: $ref: './communication-standard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml' + + # information-standards + /information-standards: + $ref: './information-standards/_paths/information-standards.yaml' + /information-standards/{informationStandardId}: + $ref: './information-standards/_paths/information-standards_{informationStandardId}.yaml' + + # information-standard-versions + /information-standard-versions: + $ref: './information-standard-versions/_paths/information-standard-versions.yaml' + /information-standard-versions/{informationStandardVersionId}: + $ref: './information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml' # trust-frameworks /trust-frameworks: From 4d3dee32ef617ce60fac171f9c4c0202c8dbedc6 Mon Sep 17 00:00:00 2001 From: iMvBremen Date: Mon, 21 Oct 2024 10:15:00 +0200 Subject: [PATCH 2/5] Update api-specifications versions#description.md --- src/dist/v1beta1.yaml | 1485 +++++++++++++---- .../versions/_paths/versions#description.md | 4 + 2 files changed, 1176 insertions(+), 313 deletions(-) diff --git a/src/dist/v1beta1.yaml b/src/dist/v1beta1.yaml index 399110e..8aa1980 100644 --- a/src/dist/v1beta1.yaml +++ b/src/dist/v1beta1.yaml @@ -68,6 +68,9 @@ tags: - name: api-specifications.versions.communication-standard-versions description: API specification version communication standard versions API x-displayName: API specification version communication standard versions + - name: api-specifications.versions.information-standard-versions + description: API specification version information standard versions API + x-displayName: API specification version information standard versions - name: api-specifications.versions.trust-framework-versions description: API specification version trust framework versions API x-displayName: API specification version trust framework versions @@ -77,6 +80,12 @@ tags: - name: communication-standard-versions description: Communication standard versions API x-displayName: Communication standard versions + - name: information-standards + description: Information standards API + x-displayName: Information standards + - name: information-standard-versions + description: Information standard versions API + x-displayName: Information standard versions - name: trust-frameworks description: Trust frameworks API x-displayName: Trust frameworks @@ -1330,6 +1339,10 @@ paths: | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `mainVersion.informationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.informationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.informationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `mainVersion.informationStandardVersions.$it.informationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.informationStandardVersions,eq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.informationStandardVersions,neq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(mainVersion.trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `mainVersion.trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | @@ -1618,6 +1631,10 @@ paths: | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `informationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(informationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `informationStandardVersions.$it.informationStandardId` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(informationStandardVersions,neq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | @@ -3185,6 +3202,73 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' + /api-specifications/{apiSpecificationId}/versions/{versionId}/information-standard-versions/{informationStandardVersionId}: + put: + summary: Set an information standard version for an API specification version + description: | + Sets a single information standard version for an API specification version. + operationId: setApiSpecificationVersionInformationStandardVersion + security: + - oauth2: + - api-specifications:write + tags: + - api-specifications.versions.information-standard-versions + parameters: + - $ref: '#/components/parameters/apiSpecificationId' + - $ref: '#/components/parameters/versionId' + - $ref: '#/components/parameters/informationStandardVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + delete: + summary: Delete an information standard version from an API specification version + description: | + Deletes a single information standard version from an API specification version. + operationId: deleteApiSpecificationVersionInformationStandardVersion + security: + - oauth2: + - api-specifications:write + tags: + - api-specifications.versions.information-standard-versions + parameters: + - $ref: '#/components/parameters/apiSpecificationId' + - $ref: '#/components/parameters/versionId' + - $ref: '#/components/parameters/informationStandardVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' /api-specifications/{apiSpecificationId}/versions/{versionId}/trust-framework-versions/{trustFrameworkVersionId}: put: summary: Set a trust framework version for an API specification version @@ -3748,11 +3832,11 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' - /trust-frameworks: + /information-standards: get: - summary: List all trust frameworks + summary: List all information standards description: |- - Returns a list of trust frameworks. + Returns a list of information standards.
Details @@ -3790,17 +3874,17 @@ paths: |------------------------------|-------------------------|----------|----------------------------------------------------------------------| | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"MedMij Afsprakenstelsel")` | - | | | `neq` | `?filter=neq(name,"MedMij Afsprakenstelsel")` | - | | | `has` | `?filter=has(name,"MedMij")` | - | | | `stw` | `?filter=stw(name,"MedMij")` | - | | | `enw` | `?filter=enw(name,"Afsprakenstelsel")` | + | `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | + | | | `neq` | `?filter=neq(name,"FHIR")` | + | | | `has` | `?filter=has(name,"FH")` | + | | | `stw` | `?filter=stw(name,"FH")` | + | | | `enw` | `?filter=enw(name,"IR")` | | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"MedMij Afsprakenstelsel")` | - | | | `neq` | `?filter=neq(description,"MedMij Afsprakenstelsel")` | - | | | `has` | `?filter=has(description,"MedMij")` | - | | | `stw` | `?filter=stw(description,"MedMij")` | - | | | `enw` | `?filter=enw(description,"Afsprakenstelsel")` | + | `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | + | | | `neq` | `?filter=neq(description,"FHIR")` | + | | | `has` | `?filter=has(description,"FH")` | + | | | `stw` | `?filter=stw(description,"FH")` | + | | | `enw` | `?filter=enw(description,"IR")` | | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | @@ -3820,12 +3904,12 @@ paths: | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` |
- operationId: listTrustFrameworks + operationId: listInformationStandards security: - oauth2: - - trust-frameworks:read + - information-standards:read tags: - - trust-frameworks + - information-standards parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/skip' @@ -3840,7 +3924,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/TrustFramework_Read' + $ref: '#/components/schemas/InformationStandard_Read' headers: Total-Count: $ref: '#/components/headers/Total-Count' @@ -3859,28 +3943,28 @@ paths: 5XX: $ref: '#/components/responses/InternalError' post: - summary: Add a trust framework + summary: Add an information standard description: | - Adds a trust framework to the collection. - operationId: addTrustFramework + Adds an information standard to the collection. + operationId: addInformationStandard security: - oauth2: - - trust-frameworks:write + - information-standards:write tags: - - trust-frameworks + - information-standards requestBody: - description: Trust framework object to add + description: Information standard object to add content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Create' + $ref: '#/components/schemas/InformationStandard_Create' responses: '201': description: Created content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Create_Response' + $ref: '#/components/schemas/InformationStandard_Create_Response' '400': $ref: '#/components/responses/BadRequestError' '401': @@ -3895,26 +3979,26 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' - /trust-frameworks/{trustFrameworkId}: + /information-standards/{informationStandardId}: get: - summary: Get a trust framework by ID + summary: Get an information standard by ID description: | - Returns a single trust framework. - operationId: getTrustFrameworkById + Returns a single information standard. + operationId: getInformationStandardById security: - oauth2: - - trust-frameworks:read + - information-standards:read tags: - - trust-frameworks + - information-standards parameters: - - $ref: '#/components/parameters/trustFrameworkId' + - $ref: '#/components/parameters/informationStandardId' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Read' + $ref: '#/components/schemas/InformationStandard_Read' '400': $ref: '#/components/responses/BadRequestError' '401': @@ -3932,30 +4016,30 @@ paths: 5XX: $ref: '#/components/responses/InternalError' patch: - summary: Update a trust framework + summary: Update an information standard description: | - Updates a single trust framework. - operationId: updateTrustFramework + Updates a single information standard. + operationId: updateInformationStandard security: - oauth2: - - trust-frameworks:write + - information-standards:write tags: - - trust-frameworks + - information-standards parameters: - - $ref: '#/components/parameters/trustFrameworkId' + - $ref: '#/components/parameters/informationStandardId' requestBody: - description: Updated trust framework object + description: Updated information standard object content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Update' + $ref: '#/components/schemas/InformationStandard_Update' responses: '200': description: Updated content: application/json: schema: - $ref: '#/components/schemas/TrustFramework_Read' + $ref: '#/components/schemas/InformationStandard_Read' '400': $ref: '#/components/responses/BadRequestError' '401': @@ -3972,11 +4056,11 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' - /trust-framework-versions: + /information-standard-versions: get: - summary: List all trust framework versions + summary: List all information standard versions description: |- - Returns a list of trust framework versions. + Returns a list of information standard versions.
Details @@ -4022,82 +4106,82 @@ paths: The following table lists the field names and operators you can use in a filter expression. - | Field | Type | Operator | Example | - |---------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------| - | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | - | | | `neq` | `?filter=neq(name,"1.2.0")` | - | | | `has` | `?filter=has(name,"1.2")` | - | | | `stw` | `?filter=stw(name,"1.2")` | - | | | `enw` | `?filter=enw(name,"2.0")` | - | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | - | | | `neq` | `?filter=neq(description,"1.2.0")` | - | | | `has` | `?filter=has(description,"1.2")` | - | | | `stw` | `?filter=stw(description,"1.2")` | - | | | `enw` | `?filter=enw(description,"2.0")` | - | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | - | `trustFrameworkId` | `uuid` | `eq` | `?filter=eq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | - | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | - | | | `neq` | `?filter=neq(semVer.major,1)` | - | | | `gt` | `?filter=gt(semVer.major,1)` | - | | | `gte` | `?filter=gte(semVer.major,1)` | - | | | `lt` | `?filter=lt(semVer.major,1)` | - | | | `lte` | `?filter=lte(semVer.major,1)` | - | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | - | | | `neq` | `?filter=neq(semVer.minor,2)` | - | | | `gt` | `?filter=gt(semVer.minor,2)` | - | | | `gte` | `?filter=gte(semVer.minor,2)` | - | | | `lt` | `?filter=lt(semVer.minor,2)` | - | | | `lte` | `?filter=lte(semVer.minor,2)` | - | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | - | | | `neq` | `?filter=neq(semVer.patch,0)` | - | | | `gt` | `?filter=gt(semVer.patch,0)` | - | | | `gte` | `?filter=gte(semVer.patch,0)` | - | | | `lt` | `?filter=lt(semVer.patch,0)` | - | | | `lte` | `?filter=lte(semVer.patch,0)` | - | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | - | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | - | | | `has` | `?filter=has(semVer.preRelease,"be")` | - | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | - | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | - | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | - | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | - | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | - | | | `has` | `?filter=has(semVer.build,"exp.sha")` | - | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | - | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | - | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | - | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | - | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | - | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | - | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + | Field | Type | Operator | Example | + |---------------------------|-------------------------|----------|-------------------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | + | | | `neq` | `?filter=neq(name,"1.2.0")` | + | | | `has` | `?filter=has(name,"1.2")` | + | | | `stw` | `?filter=stw(name,"1.2")` | + | | | `enw` | `?filter=enw(name,"2.0")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | + | | | `neq` | `?filter=neq(description,"1.2.0")` | + | | | `has` | `?filter=has(description,"1.2")` | + | | | `stw` | `?filter=stw(description,"1.2")` | + | | | `enw` | `?filter=enw(description,"2.0")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | + | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | + | | | `neq` | `?filter=neq(semVer.major,1)` | + | | | `gt` | `?filter=gt(semVer.major,1)` | + | | | `gte` | `?filter=gte(semVer.major,1)` | + | | | `lt` | `?filter=lt(semVer.major,1)` | + | | | `lte` | `?filter=lte(semVer.major,1)` | + | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | + | | | `neq` | `?filter=neq(semVer.minor,2)` | + | | | `gt` | `?filter=gt(semVer.minor,2)` | + | | | `gte` | `?filter=gte(semVer.minor,2)` | + | | | `lt` | `?filter=lt(semVer.minor,2)` | + | | | `lte` | `?filter=lte(semVer.minor,2)` | + | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | + | | | `neq` | `?filter=neq(semVer.patch,0)` | + | | | `gt` | `?filter=gt(semVer.patch,0)` | + | | | `gte` | `?filter=gte(semVer.patch,0)` | + | | | `lt` | `?filter=lt(semVer.patch,0)` | + | | | `lte` | `?filter=lte(semVer.patch,0)` | + | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | + | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | + | | | `has` | `?filter=has(semVer.preRelease,"be")` | + | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | + | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | + | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | + | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | + | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | + | | | `has` | `?filter=has(semVer.build,"exp.sha")` | + | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | + | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | + | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | + | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` |
- operationId: listTrustFrameworkVersions + operationId: listInformationStandardVersions security: - oauth2: - - trust-frameworks:read + - information-standards:read tags: - - trust-framework-versions + - information-standard-versions parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/skip' @@ -4112,7 +4196,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' headers: Total-Count: $ref: '#/components/headers/Total-Count' @@ -4131,21 +4215,517 @@ paths: 5XX: $ref: '#/components/responses/InternalError' post: - summary: Add a trust framework version + summary: Add an information standard version description: | - Adds a trust framework version to the collection. - operationId: addTrustFrameworkVersion + Adds an information standard version to the collection. + operationId: addInformationStandardVersion security: - oauth2: - - trust-frameworks:write + - information-standards:write tags: - - trust-framework-versions + - information-standard-versions requestBody: - description: Trust framework version object to add + description: Information standard version object to add content: application/json: schema: - $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /information-standard-versions/{informationStandardVersionId}: + get: + summary: Get an information standard version by ID + description: | + Returns a single information standard version. + operationId: getInformationStandardVersionById + security: + - oauth2: + - information-standards:read + tags: + - information-standard-versions + parameters: + - $ref: '#/components/parameters/informationStandardVersionId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + patch: + summary: Update an information standard version + description: | + Updates a single information standard version. + operationId: updateInformationStandardVersion + security: + - oauth2: + - information-standards:write + tags: + - information-standard-versions + parameters: + - $ref: '#/components/parameters/informationStandardVersionId' + requestBody: + description: Updated information standard version object + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_Update' + responses: + '200': + description: Updated + content: + application/json: + schema: + $ref: '#/components/schemas/InformationStandardVersion_CreateRead' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /trust-frameworks: + get: + summary: List all trust frameworks + description: |- + Returns a list of trust frameworks. + +
+ Details + + ## Sort expressions + + The following table lists the field names and directions you can use in a sort expression. + + | Field | Type | Direction | Example | + |---------------------|-------------|-----------|---------------------------------| + | `id` | `uuid` | `asc` | `?sort=asc(id)` | + | | | `desc` | `?sort=desc(id)` | + | `name` | `string` | `asc` | `?sort=asc(name)` | + | | | `desc` | `?sort=desc(name)` | + | `createTime` | `date-time` | `asc` | `?sort=asc(createTime)` | + | | | `desc` | `?sort=desc(createTime)` | + | `updateTime` | `date-time` | `asc` | `?sort=asc(updateTime)` | + | | | `desc` | `?sort=desc(updateTime)` | + + ### Default sort expression + + If the `sort` parameter is omitted, the default sort expression is used: + + ``` + ?sort=desc(createTime) + ``` + + This causes results to be sorted by `createTime` in descending order (from most recent to oldest). + + ## Filter expressions + + The following table lists the field names and operators you can use in a filter expression. + + | Field | Type | Operator | Example | + |------------------------------|-------------------------|----------|----------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"MedMij Afsprakenstelsel")` | + | | | `neq` | `?filter=neq(name,"MedMij Afsprakenstelsel")` | + | | | `has` | `?filter=has(name,"MedMij")` | + | | | `stw` | `?filter=stw(name,"MedMij")` | + | | | `enw` | `?filter=enw(name,"Afsprakenstelsel")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"MedMij Afsprakenstelsel")` | + | | | `neq` | `?filter=neq(description,"MedMij Afsprakenstelsel")` | + | | | `has` | `?filter=has(description,"MedMij")` | + | | | `stw` | `?filter=stw(description,"MedMij")` | + | | | `enw` | `?filter=enw(description,"Afsprakenstelsel")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + +
+ operationId: listTrustFrameworks + security: + - oauth2: + - trust-frameworks:read + tags: + - trust-frameworks + parameters: + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/sort' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' + responses: + '200': + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrustFramework_Read' + headers: + Total-Count: + $ref: '#/components/headers/Total-Count' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + post: + summary: Add a trust framework + description: | + Adds a trust framework to the collection. + operationId: addTrustFramework + security: + - oauth2: + - trust-frameworks:write + tags: + - trust-frameworks + requestBody: + description: Trust framework object to add + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Create' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Create_Response' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /trust-frameworks/{trustFrameworkId}: + get: + summary: Get a trust framework by ID + description: | + Returns a single trust framework. + operationId: getTrustFrameworkById + security: + - oauth2: + - trust-frameworks:read + tags: + - trust-frameworks + parameters: + - $ref: '#/components/parameters/trustFrameworkId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Read' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + patch: + summary: Update a trust framework + description: | + Updates a single trust framework. + operationId: updateTrustFramework + security: + - oauth2: + - trust-frameworks:write + tags: + - trust-frameworks + parameters: + - $ref: '#/components/parameters/trustFrameworkId' + requestBody: + description: Updated trust framework object + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Update' + responses: + '200': + description: Updated + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFramework_Read' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /trust-framework-versions: + get: + summary: List all trust framework versions + description: |- + Returns a list of trust framework versions. + +
+ Details + + ## Sort expressions + + The following table lists the field names and directions you can use in a sort expression. + + | Field | Type | Direction | Example | + |---------------------|-------------|-----------|---------------------------------| + | `id` | `uuid` | `asc` | `?sort=asc(id)` | + | | | `desc` | `?sort=desc(id)` | + | `name` | `string` | `asc` | `?sort=asc(name)` | + | | | `desc` | `?sort=desc(name)` | + | `publishTime` | `date-time` | `asc` | `?sort=asc(publishTime)` | + | | | `desc` | `?sort=desc(publishTime)` | + | `semVer.major` | `integer` | `asc` | `?sort=asc(semVer.major)` | + | | | `desc` | `?sort=desc(semVer.major)` | + | `semVer.minor` | `integer` | `asc` | `?sort=asc(semVer.minor)` | + | | | `desc` | `?sort=desc(semVer.minor)` | + | `semVer.patch` | `integer` | `asc` | `?sort=asc(semVer.patch)` | + | | | `desc` | `?sort=desc(semVer.patch)` | + | `semVer.preRelease` | `string` | `asc` | `?sort=asc(semVer.preRelease)` | + | | | `desc` | `?sort=desc(semVer.preRelease)` | + | `semVer.build` | `string` | `asc` | `?sort=asc(semVer.build)` | + | | | `desc` | `?sort=desc(semVer.build)` | + | `createTime` | `date-time` | `asc` | `?sort=asc(createTime)` | + | | | `desc` | `?sort=desc(createTime)` | + | `updateTime` | `date-time` | `asc` | `?sort=asc(updateTime)` | + | | | `desc` | `?sort=desc(updateTime)` | + + ### Default sort expression + + If the `sort` parameter is omitted, the default sort expression is used: + + ``` + ?sort=desc(publishTime) + ``` + + This causes results to be sorted by `publishTime` in descending order (from most recent to oldest). + + ## Filter expressions + + The following table lists the field names and operators you can use in a filter expression. + + | Field | Type | Operator | Example | + |---------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | + | | | `neq` | `?filter=neq(name,"1.2.0")` | + | | | `has` | `?filter=has(name,"1.2")` | + | | | `stw` | `?filter=stw(name,"1.2")` | + | | | `enw` | `?filter=enw(name,"2.0")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | + | | | `neq` | `?filter=neq(description,"1.2.0")` | + | | | `has` | `?filter=has(description,"1.2")` | + | | | `stw` | `?filter=stw(description,"1.2")` | + | | | `enw` | `?filter=enw(description,"2.0")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `trustFrameworkId` | `uuid` | `eq` | `?filter=eq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | + | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | + | | | `neq` | `?filter=neq(semVer.major,1)` | + | | | `gt` | `?filter=gt(semVer.major,1)` | + | | | `gte` | `?filter=gte(semVer.major,1)` | + | | | `lt` | `?filter=lt(semVer.major,1)` | + | | | `lte` | `?filter=lte(semVer.major,1)` | + | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | + | | | `neq` | `?filter=neq(semVer.minor,2)` | + | | | `gt` | `?filter=gt(semVer.minor,2)` | + | | | `gte` | `?filter=gte(semVer.minor,2)` | + | | | `lt` | `?filter=lt(semVer.minor,2)` | + | | | `lte` | `?filter=lte(semVer.minor,2)` | + | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | + | | | `neq` | `?filter=neq(semVer.patch,0)` | + | | | `gt` | `?filter=gt(semVer.patch,0)` | + | | | `gte` | `?filter=gte(semVer.patch,0)` | + | | | `lt` | `?filter=lt(semVer.patch,0)` | + | | | `lte` | `?filter=lte(semVer.patch,0)` | + | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | + | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | + | | | `has` | `?filter=has(semVer.preRelease,"be")` | + | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | + | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | + | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | + | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | + | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | + | | | `has` | `?filter=has(semVer.build,"exp.sha")` | + | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | + | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | + | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | + | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + +
+ operationId: listTrustFrameworkVersions + security: + - oauth2: + - trust-frameworks:read + tags: + - trust-framework-versions + parameters: + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/sort' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' + responses: + '200': + description: Success + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' + headers: + Total-Count: + $ref: '#/components/headers/Total-Count' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + post: + summary: Add a trust framework version + description: | + Adds a trust framework version to the collection. + operationId: addTrustFrameworkVersion + security: + - oauth2: + - trust-frameworks:write + tags: + - trust-framework-versions + requestBody: + description: Trust framework version object to add + content: + application/json: + schema: + $ref: '#/components/schemas/TrustFrameworkVersion_CreateRead' responses: '201': description: Created @@ -5877,196 +6457,11 @@ components: type: string maxLength: 1000 examples: - - https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens - BasicApiSpecificationVersionUrl: - allOf: - - $ref: '#/components/schemas/ApiSpecificationVersionUrl' - - description: The basic API specification version URL information - ApiRankingLevel: - type: string - enum: - - NONE - - OPEN_API - - TECHNICALLY_STANDARDIZED_API - - FULLY_STANDARDIZED_API - description: | - The API ranking level: - - - `NONE` - None. - - `OPEN_API` - Open API. - - `TECHNICALLY_STANDARDIZED_API` - Technically standardized API. - - `FULLY_STANDARDIZED_API` - Fully standardized API. - examples: - - OPEN_API - ApiRanking: - description: The API ranking information - type: object - required: - - score - - maximumScore - properties: - score: - description: The API ranking score - type: integer - format: int32 - minimum: 0 - examples: - - 27 - maximumScore: - description: The API ranking maximum score - type: integer - format: int32 - minimum: 0 - examples: - - 31 - ApiSpecificationVersionDeclarationOfConformity: - description: The API specification version declaration of conformity information - type: object - required: - - requirementsVersion - - id - - rankingLevel - - rankings - properties: - id: - description: The ID of the API specification version declaration of conformity - type: string - format: uuid - readOnly: true - examples: - - 188c9c2c-ea9e-48fa-8423-5e8e2f60161c - requirementsVersion: - description: The name of the API requirements version - type: string - maxLength: 255 - examples: - - 1.2.0 - rankingLevel: - description: The API specification version ranking level - readOnly: true - allOf: - - $ref: '#/components/schemas/ApiRankingLevel' - examples: - - OPEN_API - rankings: - description: | - A string-to-object map where keys are strings of `ApiRankingType` and values are objects of `ApiRanking` - readOnly: true - type: object - additionalProperties: - $ref: '#/components/schemas/ApiRanking' - examples: - - OPEN_API: - score: 27 - maximumScore: 31 - TECHNICALLY_STANDARDIZED_API: - score: 6 - maximumScore: 11 - FULLY_STANDARDIZED_API: - score: 2 - maximumScore: 6 - BasicApiSpecificationVersionDeclarationOfConformity: - allOf: - - $ref: '#/components/schemas/ApiSpecificationVersionDeclarationOfConformity' - - description: The basic API specification version declaration of conformity information - BasicApiSpecificationVersion: - allOf: - - $ref: '#/components/schemas/ApiSpecificationVersion' - - description: The basic API specification version information - type: object - required: - - urls - - lastDeclarationOfConformity - properties: - urls: - type: array - items: - $ref: '#/components/schemas/BasicApiSpecificationVersionUrl' - lastDeclarationOfConformity: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicApiSpecificationVersionDeclarationOfConformity' - ApiSpecification_Read: - allOf: - - $ref: '#/components/schemas/ApiSpecification' - - type: object - required: - - organizationId - - architecturalStyle - properties: - organizationId: - description: The ID of the organization that maintains the API specification - type: string - format: uuid - examples: - - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - organization: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicOrganization' - examples: - - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - name: Stichting MedMij - architecturalStyle: - description: The architectural style of the API specification - allOf: - - $ref: '#/components/schemas/ApiArchitecturalStyle' - examples: - - REST - mainVersionId: - description: The ID of the main version of the API specification - type: - - string - - 'null' - format: uuid - examples: - - 15261fd0-b292-45d9-b6b1-266cc922fb50 - mainVersion: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicApiSpecificationVersion' - - $ref: '#/components/schemas/BasicResponse' - ApiSpecification_Create: - allOf: - - $ref: '#/components/schemas/ApiSpecification' - - type: object - required: - - organizationId - - architecturalStyle - properties: - organizationId: - description: The ID of the organization that maintains the API specification - type: string - format: uuid - examples: - - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - organization: - readOnly: true - allOf: - - $ref: '#/components/schemas/BasicOrganization' - examples: - - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad - name: Stichting MedMij - architecturalStyle: - description: The architectural style of the API specification - allOf: - - $ref: '#/components/schemas/ApiArchitecturalStyle' - examples: - - REST - - $ref: '#/components/schemas/BasicResponse' - ApiSpecification_Update: + - https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens + BasicApiSpecificationVersionUrl: allOf: - - $ref: '#/components/schemas/ApiSpecification' - - type: object - properties: - mainVersionId: - description: The ID of the main version of the API specification - type: - - string - - 'null' - format: uuid - examples: - - 15261fd0-b292-45d9-b6b1-266cc922fb50 + - $ref: '#/components/schemas/ApiSpecificationVersionUrl' + - description: The basic API specification version URL information BasicCommunicationStandard: description: The basic communication standard information type: object @@ -6122,6 +6517,61 @@ components: examples: - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 name: FHIR + BasicInformationStandard: + description: The basic information standard information + type: object + required: + - name + - id + properties: + id: + description: The ID of the information standard + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: + description: The name of the information standard + type: string + maxLength: 255 + examples: + - FHIR + BasicInformationStandardVersion: + description: The basic information standard version information + type: object + required: + - id + - name + - informationStandardId + properties: + id: + description: The ID of the information standard version + type: string + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + name: + description: The name of the information standard version + type: string + maxLength: 255 + readOnly: true + examples: + - R5 + informationStandardId: + description: The ID of the information standard this version belongs to + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandard: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicInformationStandard' + examples: + - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: FHIR BasicTrustFramework: description: The basic trust framework information type: object @@ -6177,6 +6627,203 @@ components: examples: - id: 3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae name: MedMij Afsprakenstelsel + ApiRankingLevel: + type: string + enum: + - NONE + - OPEN_API + - TECHNICALLY_STANDARDIZED_API + - FULLY_STANDARDIZED_API + description: | + The API ranking level: + + - `NONE` - None. + - `OPEN_API` - Open API. + - `TECHNICALLY_STANDARDIZED_API` - Technically standardized API. + - `FULLY_STANDARDIZED_API` - Fully standardized API. + examples: + - OPEN_API + ApiRanking: + description: The API ranking information + type: object + required: + - score + - maximumScore + properties: + score: + description: The API ranking score + type: integer + format: int32 + minimum: 0 + examples: + - 27 + maximumScore: + description: The API ranking maximum score + type: integer + format: int32 + minimum: 0 + examples: + - 31 + ApiSpecificationVersionDeclarationOfConformity: + description: The API specification version declaration of conformity information + type: object + required: + - requirementsVersion + - id + - rankingLevel + - rankings + properties: + id: + description: The ID of the API specification version declaration of conformity + type: string + format: uuid + readOnly: true + examples: + - 188c9c2c-ea9e-48fa-8423-5e8e2f60161c + requirementsVersion: + description: The name of the API requirements version + type: string + maxLength: 255 + examples: + - 1.2.0 + rankingLevel: + description: The API specification version ranking level + readOnly: true + allOf: + - $ref: '#/components/schemas/ApiRankingLevel' + examples: + - OPEN_API + rankings: + description: | + A string-to-object map where keys are strings of `ApiRankingType` and values are objects of `ApiRanking` + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/ApiRanking' + examples: + - OPEN_API: + score: 27 + maximumScore: 31 + TECHNICALLY_STANDARDIZED_API: + score: 6 + maximumScore: 11 + FULLY_STANDARDIZED_API: + score: 2 + maximumScore: 6 + BasicApiSpecificationVersionDeclarationOfConformity: + allOf: + - $ref: '#/components/schemas/ApiSpecificationVersionDeclarationOfConformity' + - description: The basic API specification version declaration of conformity information + BasicApiSpecificationVersion: + allOf: + - $ref: '#/components/schemas/ApiSpecificationVersion' + - description: The basic API specification version information + type: object + required: + - urls + - lastDeclarationOfConformity + properties: + urls: + type: array + items: + $ref: '#/components/schemas/BasicApiSpecificationVersionUrl' + communicationStandardVersions: + type: array + items: + $ref: '#/components/schemas/BasicCommunicationStandardVersion' + informationStandardVersions: + type: array + items: + $ref: '#/components/schemas/BasicInformationStandardVersion' + trustFrameworkVersions: + type: array + items: + $ref: '#/components/schemas/BasicTrustFrameworkVersion' + lastDeclarationOfConformity: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicApiSpecificationVersionDeclarationOfConformity' + ApiSpecification_Read: + allOf: + - $ref: '#/components/schemas/ApiSpecification' + - type: object + required: + - organizationId + - architecturalStyle + properties: + organizationId: + description: The ID of the organization that maintains the API specification + type: string + format: uuid + examples: + - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + organization: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicOrganization' + examples: + - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + name: Stichting MedMij + architecturalStyle: + description: The architectural style of the API specification + allOf: + - $ref: '#/components/schemas/ApiArchitecturalStyle' + examples: + - REST + mainVersionId: + description: The ID of the main version of the API specification + type: + - string + - 'null' + format: uuid + examples: + - 15261fd0-b292-45d9-b6b1-266cc922fb50 + mainVersion: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicApiSpecificationVersion' + - $ref: '#/components/schemas/BasicResponse' + ApiSpecification_Create: + allOf: + - $ref: '#/components/schemas/ApiSpecification' + - type: object + required: + - organizationId + - architecturalStyle + properties: + organizationId: + description: The ID of the organization that maintains the API specification + type: string + format: uuid + examples: + - 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + organization: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicOrganization' + examples: + - id: 4a7c2c17-6514-46f8-aa05-6a22fb18b4ad + name: Stichting MedMij + architecturalStyle: + description: The architectural style of the API specification + allOf: + - $ref: '#/components/schemas/ApiArchitecturalStyle' + examples: + - REST + - $ref: '#/components/schemas/BasicResponse' + ApiSpecification_Update: + allOf: + - $ref: '#/components/schemas/ApiSpecification' + - type: object + properties: + mainVersionId: + description: The ID of the main version of the API specification + type: + - string + - 'null' + format: uuid + examples: + - 15261fd0-b292-45d9-b6b1-266cc922fb50 ApiSpecificationVersion_CreateRead: allOf: - $ref: '#/components/schemas/ApiSpecificationVersion' @@ -6192,6 +6839,10 @@ components: type: array items: $ref: '#/components/schemas/BasicCommunicationStandardVersion' + informationStandardVersions: + type: array + items: + $ref: '#/components/schemas/BasicInformationStandardVersion' trustFrameworkVersions: type: array items: @@ -6451,6 +7102,189 @@ components: properties: communicationStandardId: readOnly: true + InformationStandardVersion: + description: The information standard version information + type: object + required: + - name + - informationStandardId + - publishTime + - semVer + - lifecycleState + - id + properties: + id: + description: The ID of the information standard version + type: string + format: uuid + readOnly: true + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + name: + description: The name of the information standard version + type: string + maxLength: 255 + examples: + - R5 + description: + description: The description of the information standard version + type: + - string + - 'null' + maxLength: 1000 + examples: + - FHIR Specification 5.0.0 + informationStandardId: + description: The ID of the information standard this version belongs to + type: string + format: uuid + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandard: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicInformationStandard' + examples: + - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: FHIR + publishTime: + description: The date and time at which the information standard version was published + type: string + format: date-time + examples: + - '2023-03-26T12:00:00.0000000Z' + semVer: + allOf: + - $ref: '#/components/schemas/SemVer' + examples: + - major: 5 + minor: 0 + patch: 0 + lifecycleState: + description: The lifecycle state of the information standard version + allOf: + - $ref: '#/components/schemas/ProductLifecycleState' + examples: + - PUBLISHED + url: + description: The URL of the information standard version + type: + - string + - 'null' + maxLength: 1000 + examples: + - https://hl7.org/fhir/R5 + MainInformationStandardVersion: + allOf: + - $ref: '#/components/schemas/InformationStandardVersion' + - type: object + properties: + informationStandardId: + writeOnly: true + informationStandard: + writeOnly: true + InformationStandard: + description: The information standard information + type: object + required: + - name + - organizationId + - url + - id + properties: + id: + description: The ID of the information standard + type: string + format: uuid + readOnly: true + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + name: + description: The name of the information standard + type: string + maxLength: 255 + examples: + - FHIR + description: + description: The description of the information standard + type: + - string + - 'null' + maxLength: 1000 + examples: + - FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability. + organizationId: + description: The ID of the organization that maintains the information standard + type: string + format: uuid + examples: + - a70590c6-06ce-4dba-9098-ed996335bdec + organization: + readOnly: true + allOf: + - $ref: '#/components/schemas/BasicOrganization' + examples: + - id: a70590c6-06ce-4dba-9098-ed996335bdec + name: HL7 Nederland + url: + description: The URL of the information standard + type: string + maxLength: 1000 + examples: + - https://hl7.org/fhir/ + mainVersionId: + description: The ID of the main version of the information standard + type: + - string + - 'null' + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada + mainVersion: + readOnly: true + allOf: + - $ref: '#/components/schemas/MainInformationStandardVersion' + InformationStandard_Read: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - $ref: '#/components/schemas/BasicResponse' + InformationStandard_Create: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - type: object + properties: + mainVersionId: + readOnly: true + - $ref: '#/components/schemas/BasicResponse' + InformationStandard_Create_Response: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - type: object + properties: + mainVersionId: + writeOnly: true + mainVersion: + readOnly: false + writeOnly: true + - $ref: '#/components/schemas/BasicResponse' + InformationStandard_Update: + allOf: + - $ref: '#/components/schemas/InformationStandard' + - type: object + properties: + organizationId: + readOnly: true + InformationStandardVersion_CreateRead: + allOf: + - $ref: '#/components/schemas/InformationStandardVersion' + - $ref: '#/components/schemas/BasicResponse' + InformationStandardVersion_Update: + allOf: + - $ref: '#/components/schemas/InformationStandardVersion' + - type: object + properties: + informationStandardId: + readOnly: true TrustFrameworkVersion: description: The trust framework version information type: object @@ -7098,6 +7932,16 @@ components: format: uuid examples: - 8ae84d7f-73e7-4f08-b839-c73c97128ada + informationStandardVersionId: + name: informationStandardVersionId + in: path + required: true + description: The ID of the information standard version + schema: + type: string + format: uuid + examples: + - 8ae84d7f-73e7-4f08-b839-c73c97128ada trustFrameworkVersionId: name: trustFrameworkVersionId in: path @@ -7118,6 +7962,16 @@ components: format: uuid examples: - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + informationStandardId: + name: informationStandardId + in: path + required: true + description: The ID of the information standard + schema: + type: string + format: uuid + examples: + - 05d8de10-1932-4e7f-badf-655c1a82fcc3 trustFrameworkId: name: trustFrameworkId in: path @@ -7305,11 +8159,16 @@ x-tagGroups: - api-specifications.versions.urls - api-specifications.versions.declarations-of-conformity - api-specifications.versions.communication-standard-versions + - api-specifications.versions.information-standard-versions - api-specifications.versions.trust-framework-versions - name: Communication standards tags: - communication-standards - communication-standard-versions + - name: Information standards + tags: + - information-standards + - information-standard-versions - name: Trust frameworks tags: - trust-frameworks diff --git a/src/v1beta1/api-specifications/versions/_paths/versions#description.md b/src/v1beta1/api-specifications/versions/_paths/versions#description.md index 71f1042..cef8e18 100644 --- a/src/v1beta1/api-specifications/versions/_paths/versions#description.md +++ b/src/v1beta1/api-specifications/versions/_paths/versions#description.md @@ -104,6 +104,10 @@ The following table lists the field names and operators you can use in a filter | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `informationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(informationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `informationStandardVersions.$it.informationStandardId` | `uuid` | `eq` | `?filter=any(informationStandardVersions,eq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(informationStandardVersions,neq($it.informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | | `trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | From b6906e4cf1bbb669e252eeed190940b187b9b3ef Mon Sep 17 00:00:00 2001 From: iMvBremen Date: Mon, 21 Oct 2024 10:45:13 +0200 Subject: [PATCH 3/5] Add CareType - Update information-standard endpoints to include CareType --- src/dist/v1beta1.yaml | 366 +++++++++++++----- src/v1beta1/_schemas.yaml | 2 + src/v1beta1/_schemas/CareType.yaml | 155 ++++++++ ...formation-standard-versions#description.md | 136 +++---- .../_schemas/InformationStandardVersion.yaml | 11 +- .../information-standards#description.md | 66 ++-- 6 files changed, 537 insertions(+), 199 deletions(-) create mode 100644 src/v1beta1/_schemas/CareType.yaml diff --git a/src/dist/v1beta1.yaml b/src/dist/v1beta1.yaml index 8aa1980..aae0270 100644 --- a/src/dist/v1beta1.yaml +++ b/src/dist/v1beta1.yaml @@ -3870,38 +3870,40 @@ paths: The following table lists the field names and operators you can use in a filter expression. - | Field | Type | Operator | Example | - |------------------------------|-------------------------|----------|----------------------------------------------------------------------| - | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | - | | | `neq` | `?filter=neq(name,"FHIR")` | - | | | `has` | `?filter=has(name,"FH")` | - | | | `stw` | `?filter=stw(name,"FH")` | - | | | `enw` | `?filter=enw(name,"IR")` | - | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | - | | | `neq` | `?filter=neq(description,"FHIR")` | - | | | `has` | `?filter=has(description,"FH")` | - | | | `stw` | `?filter=stw(description,"FH")` | - | | | `enw` | `?filter=enw(description,"IR")` | - | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | - | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | - | | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | - | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | - | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + | Field | Type | Operator | Example | + |------------------------------|-------------------------|----------|-----------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | + | | | `neq` | `?filter=neq(name,"FHIR")` | + | | | `has` | `?filter=has(name,"FH")` | + | | | `stw` | `?filter=stw(name,"FH")` | + | | | `enw` | `?filter=enw(name,"IR")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | + | | | `neq` | `?filter=neq(description,"FHIR")` | + | | | `has` | `?filter=has(description,"FH")` | + | | | `stw` | `?filter=stw(description,"FH")` | + | | | `enw` | `?filter=enw(description,"IR")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | + | `mainVersion.careTypes.$it` | `CareType` | `eq` | `?filter=any(mainVersion.careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | + | | | `neq` | `?filter=all(mainVersion.careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | operationId: listInformationStandards @@ -4106,74 +4108,76 @@ paths: The following table lists the field names and operators you can use in a filter expression. - | Field | Type | Operator | Example | - |---------------------------|-------------------------|----------|-------------------------------------------------------------------------------| - | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | - | | | `neq` | `?filter=neq(name,"1.2.0")` | - | | | `has` | `?filter=has(name,"1.2")` | - | | | `stw` | `?filter=stw(name,"1.2")` | - | | | `enw` | `?filter=enw(name,"2.0")` | - | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | - | | | `neq` | `?filter=neq(description,"1.2.0")` | - | | | `has` | `?filter=has(description,"1.2")` | - | | | `stw` | `?filter=stw(description,"1.2")` | - | | | `enw` | `?filter=enw(description,"2.0")` | - | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | Field | Type | Operator | Example | + |-------------------------|-------------------------|----------|-----------------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | + | | | `neq` | `?filter=neq(name,"1.2.0")` | + | | | `has` | `?filter=has(name,"1.2")` | + | | | `stw` | `?filter=stw(name,"1.2")` | + | | | `enw` | `?filter=enw(name,"2.0")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | + | | | `neq` | `?filter=neq(description,"1.2.0")` | + | | | `has` | `?filter=has(description,"1.2")` | + | | | `stw` | `?filter=stw(description,"1.2")` | + | | | `enw` | `?filter=enw(description,"2.0")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | | `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | - | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | - | | | `neq` | `?filter=neq(semVer.major,1)` | - | | | `gt` | `?filter=gt(semVer.major,1)` | - | | | `gte` | `?filter=gte(semVer.major,1)` | - | | | `lt` | `?filter=lt(semVer.major,1)` | - | | | `lte` | `?filter=lte(semVer.major,1)` | - | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | - | | | `neq` | `?filter=neq(semVer.minor,2)` | - | | | `gt` | `?filter=gt(semVer.minor,2)` | - | | | `gte` | `?filter=gte(semVer.minor,2)` | - | | | `lt` | `?filter=lt(semVer.minor,2)` | - | | | `lte` | `?filter=lte(semVer.minor,2)` | - | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | - | | | `neq` | `?filter=neq(semVer.patch,0)` | - | | | `gt` | `?filter=gt(semVer.patch,0)` | - | | | `gte` | `?filter=gte(semVer.patch,0)` | - | | | `lt` | `?filter=lt(semVer.patch,0)` | - | | | `lte` | `?filter=lte(semVer.patch,0)` | - | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | - | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | - | | | `has` | `?filter=has(semVer.preRelease,"be")` | - | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | - | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | - | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | - | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | - | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | - | | | `has` | `?filter=has(semVer.build,"exp.sha")` | - | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | - | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | - | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | - | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | - | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | - | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | - | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | + | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | + | | | `neq` | `?filter=neq(semVer.major,1)` | + | | | `gt` | `?filter=gt(semVer.major,1)` | + | | | `gte` | `?filter=gte(semVer.major,1)` | + | | | `lt` | `?filter=lt(semVer.major,1)` | + | | | `lte` | `?filter=lte(semVer.major,1)` | + | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | + | | | `neq` | `?filter=neq(semVer.minor,2)` | + | | | `gt` | `?filter=gt(semVer.minor,2)` | + | | | `gte` | `?filter=gte(semVer.minor,2)` | + | | | `lt` | `?filter=lt(semVer.minor,2)` | + | | | `lte` | `?filter=lte(semVer.minor,2)` | + | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | + | | | `neq` | `?filter=neq(semVer.patch,0)` | + | | | `gt` | `?filter=gt(semVer.patch,0)` | + | | | `gte` | `?filter=gte(semVer.patch,0)` | + | | | `lt` | `?filter=lt(semVer.patch,0)` | + | | | `lte` | `?filter=lte(semVer.patch,0)` | + | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | + | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | + | | | `has` | `?filter=has(semVer.preRelease,"be")` | + | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | + | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | + | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | + | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | + | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | + | | | `has` | `?filter=has(semVer.build,"exp.sha")` | + | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | + | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | + | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | + | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | + | `careTypes.$it` | `CareType` | `eq` | `?filter=any(careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | + | | | `neq` | `?filter=all(careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | operationId: listInformationStandardVersions @@ -7102,6 +7106,162 @@ components: properties: communicationStandardId: readOnly: true + CareType: + type: string + enum: + - GENERAL_PRACTITIONERS + - PHARMACISTS + - MEDICAL_SPECIALISTS + - PHYSIOTHERAPISTS + - SPEECH_THERAPISTS + - HOSPITALS + - EXERCISE_THERAPISTS + - MIDWIVES + - DENTAL_SPECIALISTS_ORAL_DISEASES_AND_MAXILLOFACIAL_SURGERY + - DENTISTS + - DENTAL_SPECIALISTS_DENTOMAXILLOFACIAL_ORTHOPEDICS + - OCCUPATIONAL_PHYSICIANS + - LEGAL_ENTITIES + - DIALYSIS_CENTERS + - AUDIOLOGY_CENTERS + - RADIOTHERAPY_CENTERS + - SERVICE_STRUCTURES_AFTER_HOURS_SERVICES + - INDEPENDENT_TREATMENT_CENTERS + - INSTITUTIONS_FOR_REHABILITATION_DAY_TREATMENT + - DIETITIANS + - INSTITUTIONS_FOR_PSYCHIATRIC_DAY_TREATMENT + - PODIATRISTS + - INSTITUTIONS_FOR_PEOPLE_WITH_INTELLECTUAL_DISABILITIES + - BLOOD_BANKS + - MUNICIPAL_HEALTH_SERVICES_INSTITUTIONS + - MATERNITY_CENTERS + - THROMBOSIS_SERVICES + - ORGANIZATIONS_FOR_THE_VISUALLY_IMPAIRED + - AMBULANCE_SERVICES + - HEALTH_CENTERS + - DENTAL_CENTERS + - INSTITUTIONS_FOR_YOUTH_DENTAL_CARE + - INSTITUTIONS_FOR_THE_HEARING_IMPAIRED + - SELF_EMPLOYED_PROFESSIONALS_IN_COMMUNITY_NURSING + - NURSING_HOMES + - MANAGEMENT_FOUNDATIONS_FOR_NURSING_HOMES + - OPTOMETRISTS + - NURSING_HOMES_FOR_SOMATIC_ILLNESSES + - NURSING_HOMES_FOR_PSYCHOGERIATRIC_PATIENTS + - COMBINED_NURSING_HOMES + - OTHER_INSTITUTIONS + - ABORTION_CLINICS + - LABORATORIES + - CLINICAL_GENETICS_CENTERS + - EUROTRANSPLANT + - VARIOUS_PARTNERSHIPS + - MENTAL_HEALTH_INSTITUTIONS + - ALCOHOL_AND_DRUG_COUNSELING_CENTERS + - PHYSICIAN_ASSISTANT + - CENTRAL_AMBULANCE_DISPATCH + - DAY_CARE_FACILITIES_FOR_THE_ELDERLY + - MANAGEMENT_FOUNDATIONS_FOR_DAY_CARE_CENTERS + - FAMILY_REPLACEMENT_HOMES + - UMBRELLA_ORGANIZATIONS_LONG_TERM_CARE_ACT + - NETWORK_ORGANIZATIONS + - DAYCARE_CENTERS + - REGIONAL_INSTITUTIONS_FOR_PROTECTED_LIVING + - LONG_TERM_CARE_ACT_COMBINED + - OCCUPATIONAL_HEALTH_SERVICES + - HOME_CARE_ORGANIZATIONS + - SUPPLIERS_OF_ASSISTIVE_DEVICES + - SOCIAL_PEDAGOGICAL_SERVICES + - REGIONAL_INSTITUTIONS_FOR_OUTPATIENT_MENTAL_HEALTH_CARE + - OTHER_PHYSICIANS + - TAXI_OPERATORS + - DENTAL_HYGIENISTS + - OCCUPATIONAL_THERAPISTS + - BEAUTY_SPECIALISTS + - OTHER_THERAPISTS_AND_COMPLEMENTARY_AND_ALTERNATIVE_MEDICINE + - NURSES + - DENTAL_TECHNICIANS_DENTAL_PROSTHETISTS + - PSYCHOLOGICAL_CARE_PROVIDERS + - PEDICURISTS + - CLAIMANTS_SERVICE_AGENCIES_HEALTH_INSURERS + description: | + Care type: + + - `GENERAL_PRACTITIONERS` - General Practitioners + - `PHARMACISTS` - Pharmacists + - `MEDICAL_SPECIALISTS` - Medical Specialists + - `PHYSIOTHERAPISTS` - Physiotherapists + - `SPEECH_THERAPISTS` - Speech Therapists + - `HOSPITALS` - Hospitals + - `EXERCISE_THERAPISTS` - Exercise Therapists + - `MIDWIVES` - Midwives + - `DENTAL_SPECIALISTS_ORAL_DISEASES_AND_MAXILLOFACIAL_SURGERY` - Dental Specialists (Oral Diseases and Maxillofacial Surgery) + - `DENTISTS` - Dentists + - `DENTAL_SPECIALISTS_DENTOMAXILLOFACIAL_ORTHOPEDICS` - Dental Specialists (Dentomaxillofacial Orthopedics) + - `OCCUPATIONAL_PHYSICIANS` - Occupational Physicians + - `LEGAL_ENTITIES` - Legal Entities + - `DIALYSIS_CENTERS` - Dialysis Centers + - `AUDIOLOGY_CENTERS` - Audiology Centers + - `RADIOTHERAPY_CENTERS` - Radiotherapy Centers + - `SERVICE_STRUCTURES_AFTER_HOURS_SERVICES` - Service Structures (After-Hours Services) + - `INDEPENDENT_TREATMENT_CENTERS` - Independent Treatment Centers + - `INSTITUTIONS_FOR_REHABILITATION_DAY_TREATMENT` - Institutions for Rehabilitation Day Treatment + - `DIETITIANS` - Dietitians + - `INSTITUTIONS_FOR_PSYCHIATRIC_DAY_TREATMENT` - Institutions for Psychiatric Day Treatment + - `PODIATRISTS` - Podiatrists + - `INSTITUTIONS_FOR_PEOPLE_WITH_INTELLECTUAL_DISABILITIES` - Institutions for People with Intellectual Disabilities + - `BLOOD_BANKS` - Blood Banks + - `MUNICIPAL_HEALTH_SERVICES_INSTITUTIONS` - Municipal Health Services (MHS) Institutions + - `MATERNITY_CENTERS` - Maternity Centers + - `THROMBOSIS_SERVICES` - Thrombosis Services + - `ORGANIZATIONS_FOR_THE_VISUALLY_IMPAIRED` - Organizations for the Visually Impaired + - `AMBULANCE_SERVICES` - Ambulance Services + - `HEALTH_CENTERS` - Health Centers + - `DENTAL_CENTERS` - Dental Centers + - `INSTITUTIONS_FOR_YOUTH_DENTAL_CARE` - Institutions for Youth Dental Care + - `INSTITUTIONS_FOR_THE_HEARING_IMPAIRED` - Institutions for the Hearing Impaired + - `SELF_EMPLOYED_PROFESSIONALS_IN_COMMUNITY_NURSING` - Self-employed Professionals in Community Nursing / Personal Budget Providers / Management Foundations + - `NURSING_HOMES` - Nursing Homes + - `MANAGEMENT_FOUNDATIONS_FOR_NURSING_HOMES` - Management Foundations for Nursing Homes + - `OPTOMETRISTS` - Optometrists + - `NURSING_HOMES_FOR_SOMATIC_ILLNESSES` - Nursing Homes for Somatic Illnesses + - `NURSING_HOMES_FOR_PSYCHOGERIATRIC_PATIENTS` - Nursing Homes for Psychogeriatric Patients + - `COMBINED_NURSING_HOMES` - Combined Nursing Homes + - `OTHER_INSTITUTIONS` - Other Institutions + - `ABORTION_CLINICS` - Abortion Clinics + - `LABORATORIES` - Laboratories + - `CLINICAL_GENETICS_CENTERS` - Clinical Genetics Centers + - `EUROTRANSPLANT` - Eurotransplant + - `VARIOUS_PARTNERSHIPS` - Various Partnerships + - `MENTAL_HEALTH_INSTITUTIONS` - Mental Health Institutions (Crisis Services / Acute Psychiatric Admission Units) + - `ALCOHOL_AND_DRUG_COUNSELING_CENTERS` - Alcohol and Drug Counseling Centers + - `PHYSICIAN_ASSISTANT` - Physician Assistant + - `CENTRAL_AMBULANCE_DISPATCH` - Central Ambulance Dispatch (CAD) + - `DAY_CARE_FACILITIES_FOR_THE_ELDERLY` - Day Care Facilities for the Elderly + - `MANAGEMENT_FOUNDATIONS_FOR_DAY_CARE_CENTERS` - Management Foundations for Day Care Centers + - `FAMILY_REPLACEMENT_HOMES` - Family Replacement Homes + - `UMBRELLA_ORGANIZATIONS_LONG_TERM_CARE_ACT` - Umbrella Organizations and Management Foundations Long-Term Care Act (WLZ) + - `NETWORK_ORGANIZATIONS` - Network Organizations + - `DAYCARE_CENTERS` - Daycare Centers + - `REGIONAL_INSTITUTIONS_FOR_PROTECTED_LIVING` - Regional Institutions for Protected Living (RIBW) + - `LONG_TERM_CARE_ACT_COMBINED` - Long-Term Care Act (WLZ) Combined + - `OCCUPATIONAL_HEALTH_SERVICES` - Occupational Health Services + - `HOME_CARE_ORGANIZATIONS` - Home Care Organizations + - `SUPPLIERS_OF_ASSISTIVE_DEVICES` - Suppliers of Assistive Devices + - `SOCIAL_PEDAGOGICAL_SERVICES` - Social Pedagogical Services + - `REGIONAL_INSTITUTIONS_FOR_OUTPATIENT_MENTAL_HEALTH_CARE` - Regional Institutions for Outpatient Mental Health Care (RIAGG) + - `OTHER_PHYSICIANS` - Other Physicians + - `TAXI_OPERATORS` - Taxi Operators + - `DENTAL_HYGIENISTS` - Dental Hygienists + - `OCCUPATIONAL_THERAPISTS` - Occupational Therapists + - `BEAUTY_SPECIALISTS` - Beauty Specialists + - `OTHER_THERAPISTS_AND_COMPLEMENTARY_AND_ALTERNATIVE_MEDICINE` - Other Therapists and Complementary and Alternative Medicine + - `NURSES` - Nurses + - `DENTAL_TECHNICIANS_DENTAL_PROSTHETISTS` - Dental Technicians / Dental Prosthetists + - `PSYCHOLOGICAL_CARE_PROVIDERS` - Psychological Care Providers + - `PEDICURISTS` - Pedicurists + - `CLAIMANTS_SERVICE_AGENCIES_HEALTH_INSURERS` - Claimants / Service Agencies / Health Insurers + examples: + - GENERAL_PRACTITIONERS InformationStandardVersion: description: The information standard version information type: object @@ -7174,6 +7334,14 @@ components: maxLength: 1000 examples: - https://hl7.org/fhir/R5 + careTypes: + description: The care types that apply to the information standard version + type: array + items: + $ref: '#/components/schemas/CareType' + examples: + - - GENERAL_PRACTITIONERS + - HOSPITALS MainInformationStandardVersion: allOf: - $ref: '#/components/schemas/InformationStandardVersion' diff --git a/src/v1beta1/_schemas.yaml b/src/v1beta1/_schemas.yaml index 6eee1c7..1e07320 100644 --- a/src/v1beta1/_schemas.yaml +++ b/src/v1beta1/_schemas.yaml @@ -9,6 +9,8 @@ ApiErrorType: $ref: './_schemas/ApiErrorType.yaml' BasicResponse: $ref: './_schemas/BasicResponse.yaml' +CareType: + $ref: './_schemas/CareType.yaml' ConformityType: $ref: './_schemas/ConformityType.yaml' Country: diff --git a/src/v1beta1/_schemas/CareType.yaml b/src/v1beta1/_schemas/CareType.yaml new file mode 100644 index 0000000..32b70ce --- /dev/null +++ b/src/v1beta1/_schemas/CareType.yaml @@ -0,0 +1,155 @@ +type: string +enum: + - GENERAL_PRACTITIONERS + - PHARMACISTS + - MEDICAL_SPECIALISTS + - PHYSIOTHERAPISTS + - SPEECH_THERAPISTS + - HOSPITALS + - EXERCISE_THERAPISTS + - MIDWIVES + - DENTAL_SPECIALISTS_ORAL_DISEASES_AND_MAXILLOFACIAL_SURGERY + - DENTISTS + - DENTAL_SPECIALISTS_DENTOMAXILLOFACIAL_ORTHOPEDICS + - OCCUPATIONAL_PHYSICIANS + - LEGAL_ENTITIES + - DIALYSIS_CENTERS + - AUDIOLOGY_CENTERS + - RADIOTHERAPY_CENTERS + - SERVICE_STRUCTURES_AFTER_HOURS_SERVICES + - INDEPENDENT_TREATMENT_CENTERS + - INSTITUTIONS_FOR_REHABILITATION_DAY_TREATMENT + - DIETITIANS + - INSTITUTIONS_FOR_PSYCHIATRIC_DAY_TREATMENT + - PODIATRISTS + - INSTITUTIONS_FOR_PEOPLE_WITH_INTELLECTUAL_DISABILITIES + - BLOOD_BANKS + - MUNICIPAL_HEALTH_SERVICES_INSTITUTIONS + - MATERNITY_CENTERS + - THROMBOSIS_SERVICES + - ORGANIZATIONS_FOR_THE_VISUALLY_IMPAIRED + - AMBULANCE_SERVICES + - HEALTH_CENTERS + - DENTAL_CENTERS + - INSTITUTIONS_FOR_YOUTH_DENTAL_CARE + - INSTITUTIONS_FOR_THE_HEARING_IMPAIRED + - SELF_EMPLOYED_PROFESSIONALS_IN_COMMUNITY_NURSING + - NURSING_HOMES + - MANAGEMENT_FOUNDATIONS_FOR_NURSING_HOMES + - OPTOMETRISTS + - NURSING_HOMES_FOR_SOMATIC_ILLNESSES + - NURSING_HOMES_FOR_PSYCHOGERIATRIC_PATIENTS + - COMBINED_NURSING_HOMES + - OTHER_INSTITUTIONS + - ABORTION_CLINICS + - LABORATORIES + - CLINICAL_GENETICS_CENTERS + - EUROTRANSPLANT + - VARIOUS_PARTNERSHIPS + - MENTAL_HEALTH_INSTITUTIONS + - ALCOHOL_AND_DRUG_COUNSELING_CENTERS + - PHYSICIAN_ASSISTANT + - CENTRAL_AMBULANCE_DISPATCH + - DAY_CARE_FACILITIES_FOR_THE_ELDERLY + - MANAGEMENT_FOUNDATIONS_FOR_DAY_CARE_CENTERS + - FAMILY_REPLACEMENT_HOMES + - UMBRELLA_ORGANIZATIONS_LONG_TERM_CARE_ACT + - NETWORK_ORGANIZATIONS + - DAYCARE_CENTERS + - REGIONAL_INSTITUTIONS_FOR_PROTECTED_LIVING + - LONG_TERM_CARE_ACT_COMBINED + - OCCUPATIONAL_HEALTH_SERVICES + - HOME_CARE_ORGANIZATIONS + - SUPPLIERS_OF_ASSISTIVE_DEVICES + - SOCIAL_PEDAGOGICAL_SERVICES + - REGIONAL_INSTITUTIONS_FOR_OUTPATIENT_MENTAL_HEALTH_CARE + - OTHER_PHYSICIANS + - TAXI_OPERATORS + - DENTAL_HYGIENISTS + - OCCUPATIONAL_THERAPISTS + - BEAUTY_SPECIALISTS + - OTHER_THERAPISTS_AND_COMPLEMENTARY_AND_ALTERNATIVE_MEDICINE + - NURSES + - DENTAL_TECHNICIANS_DENTAL_PROSTHETISTS + - PSYCHOLOGICAL_CARE_PROVIDERS + - PEDICURISTS + - CLAIMANTS_SERVICE_AGENCIES_HEALTH_INSURERS +description: | + Care type: + + - `GENERAL_PRACTITIONERS` - General Practitioners + - `PHARMACISTS` - Pharmacists + - `MEDICAL_SPECIALISTS` - Medical Specialists + - `PHYSIOTHERAPISTS` - Physiotherapists + - `SPEECH_THERAPISTS` - Speech Therapists + - `HOSPITALS` - Hospitals + - `EXERCISE_THERAPISTS` - Exercise Therapists + - `MIDWIVES` - Midwives + - `DENTAL_SPECIALISTS_ORAL_DISEASES_AND_MAXILLOFACIAL_SURGERY` - Dental Specialists (Oral Diseases and Maxillofacial Surgery) + - `DENTISTS` - Dentists + - `DENTAL_SPECIALISTS_DENTOMAXILLOFACIAL_ORTHOPEDICS` - Dental Specialists (Dentomaxillofacial Orthopedics) + - `OCCUPATIONAL_PHYSICIANS` - Occupational Physicians + - `LEGAL_ENTITIES` - Legal Entities + - `DIALYSIS_CENTERS` - Dialysis Centers + - `AUDIOLOGY_CENTERS` - Audiology Centers + - `RADIOTHERAPY_CENTERS` - Radiotherapy Centers + - `SERVICE_STRUCTURES_AFTER_HOURS_SERVICES` - Service Structures (After-Hours Services) + - `INDEPENDENT_TREATMENT_CENTERS` - Independent Treatment Centers + - `INSTITUTIONS_FOR_REHABILITATION_DAY_TREATMENT` - Institutions for Rehabilitation Day Treatment + - `DIETITIANS` - Dietitians + - `INSTITUTIONS_FOR_PSYCHIATRIC_DAY_TREATMENT` - Institutions for Psychiatric Day Treatment + - `PODIATRISTS` - Podiatrists + - `INSTITUTIONS_FOR_PEOPLE_WITH_INTELLECTUAL_DISABILITIES` - Institutions for People with Intellectual Disabilities + - `BLOOD_BANKS` - Blood Banks + - `MUNICIPAL_HEALTH_SERVICES_INSTITUTIONS` - Municipal Health Services (MHS) Institutions + - `MATERNITY_CENTERS` - Maternity Centers + - `THROMBOSIS_SERVICES` - Thrombosis Services + - `ORGANIZATIONS_FOR_THE_VISUALLY_IMPAIRED` - Organizations for the Visually Impaired + - `AMBULANCE_SERVICES` - Ambulance Services + - `HEALTH_CENTERS` - Health Centers + - `DENTAL_CENTERS` - Dental Centers + - `INSTITUTIONS_FOR_YOUTH_DENTAL_CARE` - Institutions for Youth Dental Care + - `INSTITUTIONS_FOR_THE_HEARING_IMPAIRED` - Institutions for the Hearing Impaired + - `SELF_EMPLOYED_PROFESSIONALS_IN_COMMUNITY_NURSING` - Self-employed Professionals in Community Nursing / Personal Budget Providers / Management Foundations + - `NURSING_HOMES` - Nursing Homes + - `MANAGEMENT_FOUNDATIONS_FOR_NURSING_HOMES` - Management Foundations for Nursing Homes + - `OPTOMETRISTS` - Optometrists + - `NURSING_HOMES_FOR_SOMATIC_ILLNESSES` - Nursing Homes for Somatic Illnesses + - `NURSING_HOMES_FOR_PSYCHOGERIATRIC_PATIENTS` - Nursing Homes for Psychogeriatric Patients + - `COMBINED_NURSING_HOMES` - Combined Nursing Homes + - `OTHER_INSTITUTIONS` - Other Institutions + - `ABORTION_CLINICS` - Abortion Clinics + - `LABORATORIES` - Laboratories + - `CLINICAL_GENETICS_CENTERS` - Clinical Genetics Centers + - `EUROTRANSPLANT` - Eurotransplant + - `VARIOUS_PARTNERSHIPS` - Various Partnerships + - `MENTAL_HEALTH_INSTITUTIONS` - Mental Health Institutions (Crisis Services / Acute Psychiatric Admission Units) + - `ALCOHOL_AND_DRUG_COUNSELING_CENTERS` - Alcohol and Drug Counseling Centers + - `PHYSICIAN_ASSISTANT` - Physician Assistant + - `CENTRAL_AMBULANCE_DISPATCH` - Central Ambulance Dispatch (CAD) + - `DAY_CARE_FACILITIES_FOR_THE_ELDERLY` - Day Care Facilities for the Elderly + - `MANAGEMENT_FOUNDATIONS_FOR_DAY_CARE_CENTERS` - Management Foundations for Day Care Centers + - `FAMILY_REPLACEMENT_HOMES` - Family Replacement Homes + - `UMBRELLA_ORGANIZATIONS_LONG_TERM_CARE_ACT` - Umbrella Organizations and Management Foundations Long-Term Care Act (WLZ) + - `NETWORK_ORGANIZATIONS` - Network Organizations + - `DAYCARE_CENTERS` - Daycare Centers + - `REGIONAL_INSTITUTIONS_FOR_PROTECTED_LIVING` - Regional Institutions for Protected Living (RIBW) + - `LONG_TERM_CARE_ACT_COMBINED` - Long-Term Care Act (WLZ) Combined + - `OCCUPATIONAL_HEALTH_SERVICES` - Occupational Health Services + - `HOME_CARE_ORGANIZATIONS` - Home Care Organizations + - `SUPPLIERS_OF_ASSISTIVE_DEVICES` - Suppliers of Assistive Devices + - `SOCIAL_PEDAGOGICAL_SERVICES` - Social Pedagogical Services + - `REGIONAL_INSTITUTIONS_FOR_OUTPATIENT_MENTAL_HEALTH_CARE` - Regional Institutions for Outpatient Mental Health Care (RIAGG) + - `OTHER_PHYSICIANS` - Other Physicians + - `TAXI_OPERATORS` - Taxi Operators + - `DENTAL_HYGIENISTS` - Dental Hygienists + - `OCCUPATIONAL_THERAPISTS` - Occupational Therapists + - `BEAUTY_SPECIALISTS` - Beauty Specialists + - `OTHER_THERAPISTS_AND_COMPLEMENTARY_AND_ALTERNATIVE_MEDICINE` - Other Therapists and Complementary and Alternative Medicine + - `NURSES` - Nurses + - `DENTAL_TECHNICIANS_DENTAL_PROSTHETISTS` - Dental Technicians / Dental Prosthetists + - `PSYCHOLOGICAL_CARE_PROVIDERS` - Psychological Care Providers + - `PEDICURISTS` - Pedicurists + - `CLAIMANTS_SERVICE_AGENCIES_HEALTH_INSURERS` - Claimants / Service Agencies / Health Insurers +examples: + - GENERAL_PRACTITIONERS \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md b/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md index 344163a..c476ef2 100644 --- a/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md +++ b/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md @@ -44,73 +44,75 @@ This causes results to be sorted by `publishTime` in descending order (from most The following table lists the field names and operators you can use in a filter expression. -| Field | Type | Operator | Example | -|---------------------------|-------------------------|----------|-------------------------------------------------------------------------------| -| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | -| | | `neq` | `?filter=neq(name,"1.2.0")` | -| | | `has` | `?filter=has(name,"1.2")` | -| | | `stw` | `?filter=stw(name,"1.2")` | -| | | `enw` | `?filter=enw(name,"2.0")` | -| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | -| `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | -| | | `neq` | `?filter=neq(description,"1.2.0")` | -| | | `has` | `?filter=has(description,"1.2")` | -| | | `stw` | `?filter=stw(description,"1.2")` | -| | | `enw` | `?filter=enw(description,"2.0")` | -| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | +| Field | Type | Operator | Example | +|-------------------------|-------------------------|----------|-----------------------------------------------------------------------------| +| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | +| | | `neq` | `?filter=neq(name,"1.2.0")` | +| | | `has` | `?filter=has(name,"1.2")` | +| | | `stw` | `?filter=stw(name,"1.2")` | +| | | `enw` | `?filter=enw(name,"2.0")` | +| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | +| `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | +| | | `neq` | `?filter=neq(description,"1.2.0")` | +| | | `has` | `?filter=has(description,"1.2")` | +| | | `stw` | `?filter=stw(description,"1.2")` | +| | | `enw` | `?filter=enw(description,"2.0")` | +| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | | `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | -| `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | -| | | `neq` | `?filter=neq(semVer.major,1)` | -| | | `gt` | `?filter=gt(semVer.major,1)` | -| | | `gte` | `?filter=gte(semVer.major,1)` | -| | | `lt` | `?filter=lt(semVer.major,1)` | -| | | `lte` | `?filter=lte(semVer.major,1)` | -| `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | -| | | `neq` | `?filter=neq(semVer.minor,2)` | -| | | `gt` | `?filter=gt(semVer.minor,2)` | -| | | `gte` | `?filter=gte(semVer.minor,2)` | -| | | `lt` | `?filter=lt(semVer.minor,2)` | -| | | `lte` | `?filter=lte(semVer.minor,2)` | -| `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | -| | | `neq` | `?filter=neq(semVer.patch,0)` | -| | | `gt` | `?filter=gt(semVer.patch,0)` | -| | | `gte` | `?filter=gte(semVer.patch,0)` | -| | | `lt` | `?filter=lt(semVer.patch,0)` | -| | | `lte` | `?filter=lte(semVer.patch,0)` | -| `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | -| | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | -| | | `has` | `?filter=has(semVer.preRelease,"be")` | -| | | `stw` | `?filter=stw(semVer.preRelease,"be")` | -| | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | -| | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | -| `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | -| | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | -| | | `has` | `?filter=has(semVer.build,"exp.sha")` | -| | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | -| | | `enw` | `?filter=enw(semVer.build,"5114f85")` | -| | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | -| `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | -| | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | -| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | -| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | +| `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | +| | | `neq` | `?filter=neq(semVer.major,1)` | +| | | `gt` | `?filter=gt(semVer.major,1)` | +| | | `gte` | `?filter=gte(semVer.major,1)` | +| | | `lt` | `?filter=lt(semVer.major,1)` | +| | | `lte` | `?filter=lte(semVer.major,1)` | +| `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | +| | | `neq` | `?filter=neq(semVer.minor,2)` | +| | | `gt` | `?filter=gt(semVer.minor,2)` | +| | | `gte` | `?filter=gte(semVer.minor,2)` | +| | | `lt` | `?filter=lt(semVer.minor,2)` | +| | | `lte` | `?filter=lte(semVer.minor,2)` | +| `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | +| | | `neq` | `?filter=neq(semVer.patch,0)` | +| | | `gt` | `?filter=gt(semVer.patch,0)` | +| | | `gte` | `?filter=gte(semVer.patch,0)` | +| | | `lt` | `?filter=lt(semVer.patch,0)` | +| | | `lte` | `?filter=lte(semVer.patch,0)` | +| `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | +| | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | +| | | `has` | `?filter=has(semVer.preRelease,"be")` | +| | | `stw` | `?filter=stw(semVer.preRelease,"be")` | +| | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | +| | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | +| `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | +| | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | +| | | `has` | `?filter=has(semVer.build,"exp.sha")` | +| | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | +| | | `enw` | `?filter=enw(semVer.build,"5114f85")` | +| | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | +| `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | +| | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | +| `careTypes.$it` | `CareType` | `eq` | `?filter=any(careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | +| | | `neq` | `?filter=all(careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | +| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | +| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml index 85e468b..f312cc4 100644 --- a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml +++ b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml @@ -72,4 +72,13 @@ properties: - 'null' maxLength: 1000 examples: - - 'https://hl7.org/fhir/R5' \ No newline at end of file + - 'https://hl7.org/fhir/R5' + careTypes: + description: The care types that apply to the information standard version + type: array + items: + $ref: '../../_schemas/CareType.yaml' + examples: + - + - GENERAL_PRACTITIONERS + - HOSPITALS \ No newline at end of file diff --git a/src/v1beta1/information-standards/_paths/information-standards#description.md b/src/v1beta1/information-standards/_paths/information-standards#description.md index 27db73c..14c29c9 100644 --- a/src/v1beta1/information-standards/_paths/information-standards#description.md +++ b/src/v1beta1/information-standards/_paths/information-standards#description.md @@ -32,37 +32,39 @@ This causes results to be sorted by `createTime` in descending order (from most The following table lists the field names and operators you can use in a filter expression. -| Field | Type | Operator | Example | -|------------------------------|-------------------------|----------|----------------------------------------------------------------------| -| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | -| | | `neq` | `?filter=neq(name,"FHIR")` | -| | | `has` | `?filter=has(name,"FH")` | -| | | `stw` | `?filter=stw(name,"FH")` | -| | | `enw` | `?filter=enw(name,"IR")` | -| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | -| `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | -| | | `neq` | `?filter=neq(description,"FHIR")` | -| | | `has` | `?filter=has(description,"FH")` | -| | | `stw` | `?filter=stw(description,"FH")` | -| | | `enw` | `?filter=enw(description,"IR")` | -| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | -| `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | -| | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | -| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | -| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | +| Field | Type | Operator | Example | +|------------------------------|-------------------------|----------|-----------------------------------------------------------------------| +| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | +| | | `neq` | `?filter=neq(name,"FHIR")` | +| | | `has` | `?filter=has(name,"FH")` | +| | | `stw` | `?filter=stw(name,"FH")` | +| | | `enw` | `?filter=enw(name,"IR")` | +| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | +| `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | +| | | `neq` | `?filter=neq(description,"FHIR")` | +| | | `has` | `?filter=has(description,"FH")` | +| | | `stw` | `?filter=stw(description,"FH")` | +| | | `enw` | `?filter=enw(description,"IR")` | +| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | +| `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | +| | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | +| `mainVersion.careTypes.$it` | `CareType` | `eq` | `?filter=any(mainVersion.careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | +| | | `neq` | `?filter=all(mainVersion.careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | +| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | +| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | \ No newline at end of file From f43b9358dffb0707e572e7d2a922dad30bb79484 Mon Sep 17 00:00:00 2001 From: iMvBremen Date: Thu, 5 Dec 2024 10:34:58 +0100 Subject: [PATCH 4/5] Update InformationStandard examples --- src/dist/v1beta1.yaml | 55 +++++++++---------- .../path/informationStandardVersionId.yaml | 2 +- .../BasicInformationStandardVersion.yaml | 10 ++-- .../_schemas/InformationStandardVersion.yaml | 23 ++++---- .../path/informationStandardId.yaml | 2 +- .../_schemas/BasicInformationStandard.yaml | 4 +- .../_schemas/InformationStandard.yaml | 16 +++--- 7 files changed, 55 insertions(+), 57 deletions(-) diff --git a/src/dist/v1beta1.yaml b/src/dist/v1beta1.yaml index aae0270..d74529b 100644 --- a/src/dist/v1beta1.yaml +++ b/src/dist/v1beta1.yaml @@ -6534,13 +6534,13 @@ components: format: uuid readOnly: true examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 name: description: The name of the information standard type: string maxLength: 255 examples: - - FHIR + - MedMij Huisartsgegevens BasicInformationStandardVersion: description: The basic information standard version information type: object @@ -6554,28 +6554,28 @@ components: type: string format: uuid examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c name: description: The name of the information standard version type: string maxLength: 255 readOnly: true examples: - - R5 + - 2.0.41 informationStandardId: description: The ID of the information standard this version belongs to type: string format: uuid readOnly: true examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 informationStandard: readOnly: true allOf: - $ref: '#/components/schemas/BasicInformationStandard' examples: - - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 - name: FHIR + - id: 7bc962b1-601d-4759-9a87-68953e7b75e2 + name: MedMij Huisartsgegevens BasicTrustFramework: description: The basic trust framework information type: object @@ -7279,13 +7279,13 @@ components: format: uuid readOnly: true examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c name: description: The name of the information standard version type: string maxLength: 255 examples: - - R5 + - 2.0.41 description: description: The description of the information standard version type: @@ -7293,33 +7293,33 @@ components: - 'null' maxLength: 1000 examples: - - FHIR Specification 5.0.0 + - Drie aanpassingen in het Medmij Huisartsgegevens kwalificatie materiaal zodat het overeen komt met het kwalificatiescript. informationStandardId: description: The ID of the information standard this version belongs to type: string format: uuid examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 informationStandard: readOnly: true allOf: - $ref: '#/components/schemas/BasicInformationStandard' examples: - - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 - name: FHIR + - id: 7bc962b1-601d-4759-9a87-68953e7b75e2 + name: MedMij Huisartsgegevens publishTime: description: The date and time at which the information standard version was published type: string format: date-time examples: - - '2023-03-26T12:00:00.0000000Z' + - '2024-11-20T12:00:00.0000000Z' semVer: allOf: - $ref: '#/components/schemas/SemVer' examples: - - major: 5 + - major: 2 minor: 0 - patch: 0 + patch: 41 lifecycleState: description: The lifecycle state of the information standard version allOf: @@ -7333,7 +7333,7 @@ components: - 'null' maxLength: 1000 examples: - - https://hl7.org/fhir/R5 + - https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens careTypes: description: The care types that apply to the information standard version type: array @@ -7341,7 +7341,6 @@ components: $ref: '#/components/schemas/CareType' examples: - - GENERAL_PRACTITIONERS - - HOSPITALS MainInformationStandardVersion: allOf: - $ref: '#/components/schemas/InformationStandardVersion' @@ -7366,13 +7365,13 @@ components: format: uuid readOnly: true examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 name: description: The name of the information standard type: string maxLength: 255 examples: - - FHIR + - MedMij Huisartsgegevens description: description: The description of the information standard type: @@ -7380,26 +7379,26 @@ components: - 'null' maxLength: 1000 examples: - - FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability. + - 'Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.' organizationId: description: The ID of the organization that maintains the information standard type: string format: uuid examples: - - a70590c6-06ce-4dba-9098-ed996335bdec + - b9b95cd7-8d6e-4c91-8861-854828cf1730 organization: readOnly: true allOf: - $ref: '#/components/schemas/BasicOrganization' examples: - - id: a70590c6-06ce-4dba-9098-ed996335bdec - name: HL7 Nederland + - id: b9b95cd7-8d6e-4c91-8861-854828cf1730 + name: Nictiz url: description: The URL of the information standard type: string maxLength: 1000 examples: - - https://hl7.org/fhir/ + - https://informatiestandaarden.nictiz.nl/wiki/MedMij:Landingspagina_MedMij mainVersionId: description: The ID of the main version of the information standard type: @@ -7407,7 +7406,7 @@ components: - 'null' format: uuid examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c mainVersion: readOnly: true allOf: @@ -8109,7 +8108,7 @@ components: type: string format: uuid examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c trustFrameworkVersionId: name: trustFrameworkVersionId in: path @@ -8139,7 +8138,7 @@ components: type: string format: uuid examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 trustFrameworkId: name: trustFrameworkId in: path diff --git a/src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml b/src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml index 8b32098..a44fa96 100644 --- a/src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml +++ b/src/v1beta1/information-standard-versions/_parameters/path/informationStandardVersionId.yaml @@ -6,4 +6,4 @@ schema: type: string format: uuid examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c diff --git a/src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml b/src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml index 8c253e8..b4a3d9b 100644 --- a/src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml +++ b/src/v1beta1/information-standard-versions/_schemas/BasicInformationStandardVersion.yaml @@ -12,26 +12,26 @@ properties: type: string format: uuid examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c name: description: The name of the information standard version type: string maxLength: 255 readOnly: true examples: - - R5 + - 2.0.41 informationStandardId: description: The ID of the information standard this version belongs to type: string format: uuid readOnly: true examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 informationStandard: # Returned by GET, not used in POST/PUT/PATCH readOnly: true allOf: - $ref: '../../information-standards/_schemas/BasicInformationStandard.yaml' examples: - - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 - name: FHIR \ No newline at end of file + - id: 7bc962b1-601d-4759-9a87-68953e7b75e2 + name: MedMij Huisartsgegevens \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml index f312cc4..05cc847 100644 --- a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml +++ b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml @@ -17,13 +17,13 @@ properties: format: uuid readOnly: true examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c name: description: The name of the information standard version type: string maxLength: 255 examples: - - R5 + - 2.0.41 description: description: The description of the information standard version type: @@ -31,34 +31,34 @@ properties: - 'null' maxLength: 1000 examples: - - 'FHIR Specification 5.0.0' + - 'Drie aanpassingen in het Medmij Huisartsgegevens kwalificatie materiaal zodat het overeen komt met het kwalificatiescript.' informationStandardId: description: The ID of the information standard this version belongs to type: string format: uuid examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 informationStandard: # Returned by GET, not used in POST/PUT/PATCH readOnly: true allOf: - $ref: '../../information-standards/_schemas/BasicInformationStandard.yaml' examples: - - id: 05d8de10-1932-4e7f-badf-655c1a82fcc3 - name: FHIR + - id: 7bc962b1-601d-4759-9a87-68953e7b75e2 + name: MedMij Huisartsgegevens publishTime: description: The date and time at which the information standard version was published type: string format: date-time examples: - - '2023-03-26T12:00:00.0000000Z' + - '2024-11-20T12:00:00.0000000Z' semVer: allOf: - $ref: '../../_schemas/SemVer.yaml' examples: - - major: 5 + - major: 2 minor: 0 - patch: 0 + patch: 41 lifecycleState: description: The lifecycle state of the information standard version allOf: @@ -72,7 +72,7 @@ properties: - 'null' maxLength: 1000 examples: - - 'https://hl7.org/fhir/R5' + - 'https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens' careTypes: description: The care types that apply to the information standard version type: array @@ -80,5 +80,4 @@ properties: $ref: '../../_schemas/CareType.yaml' examples: - - - GENERAL_PRACTITIONERS - - HOSPITALS \ No newline at end of file + - GENERAL_PRACTITIONERS \ No newline at end of file diff --git a/src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml b/src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml index 37b61f1..389f523 100644 --- a/src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml +++ b/src/v1beta1/information-standards/_parameters/path/informationStandardId.yaml @@ -6,4 +6,4 @@ schema: type: string format: uuid examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 diff --git a/src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml b/src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml index 81c4cb8..e1ef098 100644 --- a/src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml +++ b/src/v1beta1/information-standards/_schemas/BasicInformationStandard.yaml @@ -12,10 +12,10 @@ properties: format: uuid readOnly: true examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 name: description: The name of the information standard type: string maxLength: 255 examples: - - FHIR \ No newline at end of file + - MedMij Huisartsgegevens \ No newline at end of file diff --git a/src/v1beta1/information-standards/_schemas/InformationStandard.yaml b/src/v1beta1/information-standards/_schemas/InformationStandard.yaml index 62517bc..294c171 100644 --- a/src/v1beta1/information-standards/_schemas/InformationStandard.yaml +++ b/src/v1beta1/information-standards/_schemas/InformationStandard.yaml @@ -15,13 +15,13 @@ properties: format: uuid readOnly: true examples: - - 05d8de10-1932-4e7f-badf-655c1a82fcc3 + - 7bc962b1-601d-4759-9a87-68953e7b75e2 name: description: The name of the information standard type: string maxLength: 255 examples: - - FHIR + - MedMij Huisartsgegevens description: description: The description of the information standard type: @@ -29,27 +29,27 @@ properties: - 'null' maxLength: 1000 examples: - - 'FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.' + - 'Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.' organizationId: description: The ID of the organization that maintains the information standard type: string format: uuid examples: - - a70590c6-06ce-4dba-9098-ed996335bdec + - b9b95cd7-8d6e-4c91-8861-854828cf1730 organization: # Returned by GET, not used in POST/PUT/PATCH readOnly: true allOf: - $ref: '../../organizations/_schemas/BasicOrganization.yaml' examples: - - id: a70590c6-06ce-4dba-9098-ed996335bdec - name: HL7 Nederland + - id: b9b95cd7-8d6e-4c91-8861-854828cf1730 + name: Nictiz url: description: The URL of the information standard type: string maxLength: 1000 examples: - - 'https://hl7.org/fhir/' + - 'https://informatiestandaarden.nictiz.nl/wiki/MedMij:Landingspagina_MedMij' mainVersionId: description: The ID of the main version of the information standard type: @@ -57,7 +57,7 @@ properties: - 'null' format: uuid examples: - - 8ae84d7f-73e7-4f08-b839-c73c97128ada + - 20685da1-0e1d-40b9-a0f6-5a89c444f48c mainVersion: # Returned by GET, not used in POST/PUT/PATCH readOnly: true From 94aec353a0dfcf5e8b826a44ea4cd76db699339f Mon Sep 17 00:00:00 2001 From: iMvBremen Date: Thu, 5 Dec 2024 13:35:39 +0100 Subject: [PATCH 5/5] Update information-standards#description.md --- src/dist/v1beta1.yaml | 20 +++++++++---------- .../information-standards#description.md | 20 +++++++++---------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/dist/v1beta1.yaml b/src/dist/v1beta1.yaml index d74529b..4942eb4 100644 --- a/src/dist/v1beta1.yaml +++ b/src/dist/v1beta1.yaml @@ -3874,17 +3874,17 @@ paths: |------------------------------|-------------------------|----------|-----------------------------------------------------------------------| | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | - | | | `neq` | `?filter=neq(name,"FHIR")` | - | | | `has` | `?filter=has(name,"FH")` | - | | | `stw` | `?filter=stw(name,"FH")` | - | | | `enw` | `?filter=enw(name,"IR")` | + | `name` | `string` | `eq` | `?filter=eq(name,"MedMij Huisartsgegevens")` | + | | | `neq` | `?filter=neq(name,"MedMij Huisartsgegevens")` | + | | | `has` | `?filter=has(name,"MedMij")` | + | | | `stw` | `?filter=stw(name,"MedMij")` | + | | | `enw` | `?filter=enw(name,"Huisartsgegevens")` | | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | - | | | `neq` | `?filter=neq(description,"FHIR")` | - | | | `has` | `?filter=has(description,"FH")` | - | | | `stw` | `?filter=stw(description,"FH")` | - | | | `enw` | `?filter=enw(description,"IR")` | + | `description` | `string` | `eq` | `?filter=eq(description,"MedMij Huisartsgegevens")` | + | | | `neq` | `?filter=neq(description,"MedMij Huisartsgegevens")` | + | | | `has` | `?filter=has(description,"MedMij")` | + | | | `stw` | `?filter=stw(description,"MedMij")` | + | | | `enw` | `?filter=enw(description,"Huisartsgegevens")` | | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | diff --git a/src/v1beta1/information-standards/_paths/information-standards#description.md b/src/v1beta1/information-standards/_paths/information-standards#description.md index 14c29c9..ecf7841 100644 --- a/src/v1beta1/information-standards/_paths/information-standards#description.md +++ b/src/v1beta1/information-standards/_paths/information-standards#description.md @@ -36,17 +36,17 @@ The following table lists the field names and operators you can use in a filter |------------------------------|-------------------------|----------|-----------------------------------------------------------------------| | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `name` | `string` | `eq` | `?filter=eq(name,"FHIR")` | -| | | `neq` | `?filter=neq(name,"FHIR")` | -| | | `has` | `?filter=has(name,"FH")` | -| | | `stw` | `?filter=stw(name,"FH")` | -| | | `enw` | `?filter=enw(name,"IR")` | +| `name` | `string` | `eq` | `?filter=eq(name,"MedMij Huisartsgegevens")` | +| | | `neq` | `?filter=neq(name,"MedMij Huisartsgegevens")` | +| | | `has` | `?filter=has(name,"MedMij")` | +| | | `stw` | `?filter=stw(name,"MedMij")` | +| | | `enw` | `?filter=enw(name,"Huisartsgegevens")` | | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | -| `description` | `string` | `eq` | `?filter=eq(description,"FHIR")` | -| | | `neq` | `?filter=neq(description,"FHIR")` | -| | | `has` | `?filter=has(description,"FH")` | -| | | `stw` | `?filter=stw(description,"FH")` | -| | | `enw` | `?filter=enw(description,"IR")` | +| `description` | `string` | `eq` | `?filter=eq(description,"MedMij Huisartsgegevens")` | +| | | `neq` | `?filter=neq(description,"MedMij Huisartsgegevens")` | +| | | `has` | `?filter=has(description,"MedMij")` | +| | | `stw` | `?filter=stw(description,"MedMij")` | +| | | `enw` | `?filter=enw(description,"Huisartsgegevens")` | | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` |