Skip to content

Commit

Permalink
Merge pull request #5 from iMvBremen/feature/information-standards
Browse files Browse the repository at this point in the history
Add InformationStandard endpoints
  • Loading branch information
avanbremen authored Dec 5, 2024
2 parents c621465 + 94aec35 commit f669d5e
Show file tree
Hide file tree
Showing 29 changed files with 2,513 additions and 395 deletions.
1,816 changes: 1,421 additions & 395 deletions src/dist/v1beta1.yaml

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions src/v1beta1/_parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
28 changes: 28 additions & 0 deletions src/v1beta1/_schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -164,6 +166,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'
Expand Down
155 changes: 155 additions & 0 deletions src/v1beta1/_schemas/CareType.yaml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,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"))` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"))` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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'
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: informationStandardVersionId
in: path
required: true
description: The ID of the information standard version
schema:
type: string
format: uuid
examples:
- 20685da1-0e1d-40b9-a0f6-5a89c444f48c
Loading

0 comments on commit f669d5e

Please sign in to comment.