diff --git a/learn/apis/adding-an-api-specification/index.html b/learn/apis/adding-an-api-specification/index.html index eb4d6ed..f91ad2a 100644 --- a/learn/apis/adding-an-api-specification/index.html +++ b/learn/apis/adding-an-api-specification/index.html @@ -933,6 +933,24 @@ + + +
  • + + + Add communication standard version + + + +
    • + +
  • + + + Add trust framework version + + +
    • @@ -1620,6 +1638,24 @@ + + +
  • + + + Add communication standard version + + + +
    • + +
  • + + + Add trust framework version + + +
    • @@ -3336,6 +3372,52 @@

    Set API specification main versionPostman Collection and explore our API.

    +

    Add communication standard version

    +
    +
    +
    +
    PUT https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/communication-standard-versions/8ae84d7f-73e7-4f08-b839-c73c97128ada HTTP/1.1
+
    +
    +
    +
    HTTP/1.1 204 No Content // (1)!
+
    +
      +
    1. After successfully adding the communication standard version, the API server responds with a 204 response with + no body.
      2. +
    +
    +
    +
    +
    +

    Note

    +

    To learn more, view the API reference +or fork our Postman Collection +and explore our API.

    +
    +

    Add trust framework version

    +
    +
    +
    +
    PUT https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/trust-framework-versions/78ca8495-a4f4-4b41-b97b-c912c2e96450 HTTP/1.1
+
    +
    +
    +
    HTTP/1.1 204 No Content // (1)!
+
    +
      +
    1. After successfully adding the trust framework version, the API server responds with a 204 response with + no body.
      2. +
    +
    +
    +
    +
    +

    Note

    +

    To learn more, view the API reference +or fork our Postman Collection +and explore our API.

    +
    @@ -3358,7 +3440,7 @@

    Set API specification main version - September 17, 2024 + September 26, 2024 @@ -3386,14 +3468,14 @@

    Set API specification main version - + - iMvBremen + avanbremen - + - avanbremen + iMvBremen diff --git a/search/search_index.json b/search/search_index.json index b85387c..5c166ad 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introduction to ZorgAPIs","text":"

    Effective Application Programming Interfaces (APIs) achieve interoperability and are therefore of strategic importance for an Integrated Health Information System. That is why Nictiz, in consultation with the Ministry of Health, Welfare and Sport and stakeholders, has developed an API strategy for Dutch healthcare. This strategy focuses on the development of APIs towards fully standardized data exchanges. The API Library promotes the findability of APIs that meet the requirements at a particular level of standardization.

    "},{"location":"#resources","title":"Resources","text":""},{"location":"#documentation","title":"Documentation","text":"

    Explore our documentation to gain a deeper understanding of how to harness the power of APIs in healthcare to enhance data exchange, streamline processes, and foster innovation.

    "},{"location":"nictiz/","title":"Nictiz","text":"

    Nictiz is the Dutch competence center for electronic exchange of health and care information. Nictiz develops and maintains standards for digital information management, ensuring that healthcare information can be recorded and exchanged in an unambiguous manner. To this end Nictiz maintains close cooperation with the international Standardization Organizations: IHE, HL7, SNOMED International, PCH Alliance, CEN/NEN.

    "},{"location":"nictiz/#knowledge","title":"Knowledge","text":"

    There is a vast body of knowledge about digital information management in healthcare. As a competence center, Nictiz considers sharing this knowledge an important part of its mission.

    "},{"location":"blog/","title":"Blog","text":""},{"location":"blog/2024/07/18/adding-an-avatar-to-your-organization/","title":"Adding an avatar to your organization","text":"

    ZorgAPIs API version 0.3.2 is released, which brings a new and simple way to add an avatar to your organization's page in the API Library for Dutch Healthcare.

    As part of our continuous efforts to enhance user experience, we have added the githubUrl and gitlabUrl properties to the Organization schema. These URLs will be used to retrieve the organization's avatar and display it on your page in the API Library for Dutch Healthcare.

    With this update, you can simply link your organization's GitHub or GitLab profile. The system will automatically fetch and display the avatar from these profiles, enhancing your organization's brand presence within the API Library and making it easier for users to identify and engage with your APIs.

    We encourage you to update your organization's profile and take advantage of this new functionality. We have updated our documentation to guide you through the process of adding or updating your organization details.

    "},{"location":"blog/2024/08/14/discover-the-new-api-specification-page/","title":"Discover the new API specification page","text":"

    We are excited to announce that the API specification page is now live on the API Library for Dutch Healthcare! This new feature allows you to easily explore and access API documentation.

    On this page, you will find essential API information, including the architectural style, version history, standardization level, lifecycle state and release date. Additionally, you will find links to various documentation resources, such as the functional design, technical design, or OpenAPI Specification (OAS).

    "},{"location":"blog/2024/08/14/discover-the-new-api-specification-page/#early-adopters","title":"Early adopters","text":"

    We are especially proud to highlight two early adopters of the API strategy for Dutch Healthcare: Open Health Hub and ChipSoft. Open Health Hub has successfully published their FHIR Questionnaire API, while ChipSoft has published their Zorgplatform Workflow API. By doing so, both companies have taken significant steps in advancing API standardization and interoperability in Dutch healthcare, setting a strong example for others to follow.

    "},{"location":"blog/2024/08/14/discover-the-new-api-specification-page/#get-involved","title":"Get involved","text":"

    Visit the API Library for Dutch Healthcare today to explore this new feature, learn more about these pioneering APIs, and see how the API Library continues to evolve with contributions from leading industry players. But most importantly, get involved \u2013 publish your organization and API information using our API so others can discover and adopt your solutions.

    A big thank you to everyone involved.

    "},{"location":"code/","title":"Code using ZorgAPIs","text":"

    Because ZorgAPIs is a community effort for the betterment of health data exchange, we welcome you to create and share tools that help users get started with ZorgAPIs API.

    "},{"location":"learn/","title":"Learn","text":"

    ZorgAPIs API enables the creation of applications that can interact with the API Library for Dutch Healthcare, such as retrieving API requirements, creating and managing organizations and API specifications, or publishing declarations of conformity.

    Tip

    Utilize our sandbox API to ensure your integrations are seamless and robust before publishing data to the production environment.

    "},{"location":"learn/#getting-started","title":"Getting started","text":""},{"location":"learn/authorizing-a-request/","title":"Authorizing a request","text":"

    ZorgAPIs API uses OAuth 2.0 to ensure that client requests access data securely. With OAuth 2.0, you first retrieve an access token for the API, then use that token to authenticate future requests.

    Info

    When exploring our API, fork our Postman Collection and select Get New Access Token in the Authorization tab of a request. Postman will automatically populate the relevant parts of the request. To learn more, go to Authenticate with OAuth 2.0 authentication in Postman.

    Register Log out

    "},{"location":"learn/authorizing-a-request/#how-the-authorization-code-flow-works","title":"How the Authorization Code flow works","text":"

    The example diagram below illustrates the interactions that occur during the OAuth 2.0 Authorization Code Grant flow.

    sequenceDiagram\n  participant user as User\n  participant client as Application\n  participant idp as Authorization server\n  participant api as API\n  autonumber\n\n  activate user\n  user->>client: Access\n  activate client\n  client->>idp: Request authorization\n  deactivate client\n  activate idp\n  idp->>user: Show sign in page\n  user->>idp: Sign in with credentials\n  deactivate user\n  idp->>client: Issue authorization code\n  activate client\n  client->>idp: Request token\n  idp->>idp: Validate request\n  idp->>client: Return access token\n  deactivate idp\n  client->>api: Call API with access token\n  activate api\n  api->>client: Return data\n  deactivate api\n  client->>user: Display data\n  deactivate client
    1. A user tries to access the application (the client)

    2. The application redirects to the authorization server's auth endpoint 

      https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/auth\n    ?response_type=code\n    &client_id=<client-id> <!-- (1)! -->\n    &redirect_uri=<redirect-uri> <!-- (2)! -->\n    &scope=<scopes> <!-- (3)! -->\n    &state=<state>\n

      1. For example, zorgapis.postman.
      2. For example, https://oauth.pstmn.io/v1/browser-callback.
      3. For example, api-requirements-versions:read.

    3. The authorization server shows the sign in page

    4. The user signs in with its credentials
    5. The authorization server issues an authorization code to the application

    6. The application requests an access token from the token endpoint 

      POST https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/token\n    ?grant_type=authorization_code\n    &client_id=<client-id>\n    &client_secret=<secret>\n    &code=<auth-code>\n    &redirect_uri=<redirect-uri>\n

    7. The authorization server validates the request

    8. The authorization server returns the access token
    9. The application calls a protected API endpoint using the access token
    10. The API validates the access token and returns the data
    11. The application displays the data to the user
    "},{"location":"learn/agreements/","title":"Agreements","text":"

    Learn how to add your trust framework and its versions to the API Library for Dutch Healthcare.

    "},{"location":"learn/agreements/#resources","title":"Resources","text":""},{"location":"learn/agreements/adding-a-trust-framework/","title":"Adding a trust framework","text":""},{"location":"learn/agreements/adding-a-trust-framework/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  TRUST-FRAMEWORK ||--o{ VERSION : contains\n  TRUST-FRAMEWORK }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/agreements/adding-a-trust-framework/#add-trust-framework","title":"Add trust framework","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"MedMij Afsprakenstelsel\", // (1)!\n  \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n  \"organizationId\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\", // (2)!\n  \"url\": \"https://afsprakenstelsel.medmij.nl/\"\n}\n
    1. The name of the trust framework, must be unique for this organization (see \"organizationId\").
    2. The UUID of the organization that maintains the trust framework.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"3d443c34-24a4-4640-bfe5-822627af76e2\", // (1)!\n  \"name\": \"MedMij Afsprakenstelsel\",\n  \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n  \"organizationId\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n  \"organization\": {\n    \"id\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n    \"name\": \"Stichting MedMij\"\n  },\n  \"url\": \"https://afsprakenstelsel.medmij.nl/\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the trust framework by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/adding-a-trust-framework/#add-trust-framework-version","title":"Add trust framework version","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/trust-framework-versions HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"2.2.2 Verplicht\", // (1)!\n  \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n  \"trustFrameworkId\": \"3d443c34-24a4-4640-bfe5-822627af76e2\", // (2)!\n  \"publishTime\": \"2024-09-10T12:00:00.0000000Z\", // (3)!\n  \"semVer\": { // (4)!\n    \"major\": 2,\n    \"minor\": 2,\n    \"patch\": 2\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/\"\n}\n
    1. The name of the trust framework version, must be unique for this trust framework (see \"trustFrameworkId\").
    2. The UUID of the trust framework to which this version belongs.

    3. The date and time (formatted as per ISO 8601) at which the trust framework version was published. In other words, the date and time at which this version was first made available by the organization that maintains the trust framework.

      Note: publishTime is not to be used for the date and time at which this version is published in the API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item and can be accessed via read-only property createTime.

    4. The SemVer version information. Additional properties for pre-release (\"preRelease\") and build metadata (\"build\") are available.

    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\", // (1)!\n  \"name\": \"2.2.2 Verplicht\",\n  \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n  \"trustFrameworkId\": \"3d443c34-24a4-4640-bfe5-822627af76e2\",\n  \"trustFramework\": {\n    \"id\": \"3d443c34-24a4-4640-bfe5-822627af76e2\",\n    \"name\": \"MedMij Afsprakenstelsel\"\n  },\n  \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n  \"semVer\": {\n    \"major\": 2,\n    \"minor\": 2,\n    \"patch\": 2\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the trust framework version by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/adding-a-trust-framework/#set-trust-framework-main-version","title":"Set trust framework main version","text":"RequestResponse 
    PATCH https://api.zorgapis.nl/v1beta1/trust-frameworks/3d443c34-24a4-4640-bfe5-822627af76e2 HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"mainVersionId\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\"\n}\n
    HTTP/1.1 20O OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"3d443c34-24a4-4640-bfe5-822627af76e2\",\n  \"name\": \"MedMij Afsprakenstelsel\",\n  \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n  \"organizationId\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n  \"organization\": {\n    \"id\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n    \"name\": \"Stichting MedMij\"\n  },\n  \"url\": \"https://afsprakenstelsel.medmij.nl/\",\n  \"mainVersionId\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\",\n  \"mainVersion\": {\n    \"id\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\",\n    \"name\": \"2.2.2 Verplicht\",\n    \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n    \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 2,\n      \"minor\": 2,\n      \"patch\": 2\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/\"\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/getting-trust-frameworks/","title":"Getting trust frameworks","text":""},{"location":"learn/agreements/getting-trust-frameworks/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  TRUST-FRAMEWORK ||--o{ VERSION : contains\n  TRUST-FRAMEWORK }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/agreements/getting-trust-frameworks/#get-trust-frameworks","title":"Get trust frameworks","text":"RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\", // (1)!\n    \"name\": \"MedMij Afsprakenstelsel\",\n    \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n    \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"organization\": {\n      \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n      \"name\": \"Stichting MedMij\"\n    },\n    \"url\": \"https://afsprakenstelsel.medmij.nl/\",\n    \"mainVersionId\": \"78ca8495-a4f4-4b41-b97b-c912c2e96450\", // (2)!\n    \"mainVersion\": {\n      \"id\": \"78ca8495-a4f4-4b41-b97b-c912c2e96450\",\n      \"name\": \"2.2.2 Verplicht\",\n      \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n      \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n      \"semVer\": {\n        \"major\": 2,\n        \"minor\": 2,\n        \"patch\": 2\n      },\n      \"lifecycleState\": \"PUBLISHED\",\n      \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht\"\n    }\n  },\n  ...\n]\n
    1. The UUID of the trust framework.
    2. The UUID of the main version.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/getting-trust-frameworks/#get-trust-framework-versions","title":"Get trust framework versions","text":"

    List all versions for the trust framework with id \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\":

    RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/trust-framework-versions\n    ?filter=eq(trustFrameworkId,\"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\") HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"78ca8495-a4f4-4b41-b97b-c912c2e96450\",\n    \"name\": \"2.2.2 Verplicht\",\n    \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n    \"trustFrameworkId\": \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\",\n    \"trustFramework\": {\n      \"id\": \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\",\n      \"name\": \"MedMij Afsprakenstelsel\"\n    },\n    \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 2,\n      \"minor\": 2,\n      \"patch\": 2\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht\"\n  },\n  ...\n]\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/snippets/trust-framework-entity-relationship-diagram/","title":"Trust framework entity relationship diagram","text":"
    erDiagram\n  TRUST-FRAMEWORK ||--o{ VERSION : contains\n  TRUST-FRAMEWORK }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/apis/","title":"APIs","text":"

    Learn how to add your API specification and its versions to the API Library for Dutch Healthcare.

    "},{"location":"learn/apis/#resources","title":"Resources","text":""},{"location":"learn/apis/adding-an-api-specification/","title":"Adding an API specification","text":""},{"location":"learn/apis/adding-an-api-specification/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  API-SPECIFICATION ||--o{ VERSION : contains\n  VERSION ||--o{ DECLARATION-OF-CONFORMITY : contains\n  API-SPECIFICATION }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/apis/adding-an-api-specification/#add-api-specification","title":"Add API specification","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/api-specifications HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"name\": \"Verzamelen Huisartsgegevens\", // (1)!\n  \"description\": \"Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\", // (2)!\n  \"architecturalStyle\": \"REST\" // (3)!\n}\n
    1. The name of the API specification, must be unique for this organization (see \"organizationId\").
    2. The UUID of the organization that maintains the API specification.
    3. The architectural style of the API specification, and therefore of all associated versions. For example, \"REST\" or \"SOAP\".
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"fe30bf05-de07-4556-9b17-1f82d62fe45f\", // (1)!\n  \"name\": \"Verzamelen Huisartsgegevens\",\n  \"description\": \"Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n  \"organization\": {\n    \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"name\": \"Nictiz\"\n  },\n  \"architecturalStyle\": \"REST\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API specification by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#add-api-specification-version","title":"Add API specification version","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"name\": \"2.0\", // (1)!\n  \"description\": \"Verzamelen Huisartsgegevens 2.0\",\n  \"publishTime\": \"2020-09-02T00:00:00.000Z\", // (2)!\n  \"semVer\": { // (3)!\n    \"major\": 2,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"urls\": [\n    {\n      \"type\": \"FUNCTIONAL_DESIGN\", // (4)!\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens\"\n    },\n    {\n      \"type\": \"TECHNICAL_DESIGN\",\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data\"\n    }\n  ]\n}\n
    1. The name of the API specification version, must be unique for this API specification.

    2. The date and time (formatted as per ISO 8601) at which the API specification version was published. In other words, the date and time at which this version was first made available by the organization that maintains the API specification.

      Note: publishTime is not to be used for the date and time at which this version is published in the API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item and can be accessed via read-only property createTime.

    3. The SemVer version information. Additional properties for pre-release (\"preRelease\") and build metadata (\"build\") are available.

    4. The URL type, for example, \"OPENAPI_SPECIFICATION\".
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\", // (1)!\n  \"name\": \"2.0\",\n  \"description\": \"Verzamelen Huisartsgegevens 2.0\",\n  \"publishTime\": \"2020-09-02T00:00:00.000Z\",\n  \"semVer\": {\n    \"major\": 2,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"urls\": [\n    {\n      \"id\": \"37bfbf71-570c-45c1-9fbf-7e5f63db61b8\", // (2)!\n      \"type\": \"FUNCTIONAL_DESIGN\",\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens\"\n    },\n    {\n      \"id\": \"8a87c023-aabb-454f-8e1a-3443a13f11e2\",\n      \"type\": \"TECHNICAL_DESIGN\",\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data\"\n    }\n  ]\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API specification version by the API server.
    2. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API specification version URL by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#add-declaration-of-conformity","title":"Add declaration of conformity","text":"

    This section guides you through the process of validating your API specification against the requirements for APIs in Dutch Healthcare. As part of this process, you will perform a self-assessment to determine whether your API specification is conformant.

    "},{"location":"learn/apis/adding-an-api-specification/#the-importance-of-transparency","title":"The importance of transparency","text":"

    Transparency is a key aspect of this process. By making the results of your declaration of conformity publicly available, we ensure an environment of openness and accountability. Suppliers are encouraged to submit accurate results, knowing that their declarations will be published in the API Library for Dutch Healthcare. Results will be visible to everyone and can be independently verified based on the provided evidence.

    Warning

    You must provide evidence supporting compliance claims. Detailed documentation helps maintain the integrity and credibility of your declaration.

    "},{"location":"learn/apis/adding-an-api-specification/#declarations-are-immutable","title":"Declarations are immutable","text":"

    It is important to note that a declaration of conformity cannot be changed after it has been submitted. Similar to a git commit command, a new and permanent snapshot of the API specification's current rankings and standardization level is recorded into your history.

    Info

    Although you cannot alter a submitted declaration, you can always add new declarations to reflect updates or changes. The most recently submitted declaration will be used to display your ranking levels in the API Library for Dutch Healthcare.

    "},{"location":"learn/apis/adding-an-api-specification/#providing-evidence","title":"Providing evidence","text":"

    To support your compliance with standards, specifications, guidelines, practices, policies, or laws, you must provide evidence. This may include URLs to official third-party validation reports or audits (see SD010).

    The remarks field is available for you to provide evidence for compliance claims or to explain why specific requirements may not apply to your API specification.

    Note

    Markdown is supported for the remarks field. You can use Markdown syntax to format text, include links and more to enhance the readability and organization of your remarks.

    "},{"location":"learn/apis/adding-an-api-specification/#architectural-styles","title":"Architectural styles","text":"

    When adding a declaration of conformity, it is crucial te recognize that certain requirements may only apply to specific architectural styles. Each architectural style, such as REST, SOAP, GraphQL, OData, or gRPC, has its own unique set of requirements. This approach ensures that rankings are meaningful and consistent, allowing for a fair comparison between APIs that share the same architectural principles.

    Info

    You set the architectural style when adding an API specification. This architectural style will apply to the API specification and all of its versions.

    When you publish a declaration of conformity, you must use the set of requirements specific to the architectural style you selected when adding the API specification.

    Note

    If an expected requirement is missing, the ZorgAPIs API server will return an error. If an extra requirement is provided that is not part of the expected set, the API server will ignore it.

    We provide code snippets in JSON format to assist you in creating a declaration. These examples can be easily copied and used with our Postman Collection.

    Expand to show snippets RESTSOAPGraphQLODatagRPCOther 
    {\n  \"requirementsVersion\": \"1.2.0\", // (1)!\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR-R001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR-R002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-R001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-R002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-R003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    1. The name of the API requirements version, for example \"1.2.0\", against which to validate this version of the API specification.
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR-S001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-S001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-S002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    "},{"location":"learn/apis/adding-an-api-specification/#example","title":"Example","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/declarations-of-conformity HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"requirementsVersion\": \"1.2.0\", // (1)!\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\", // (2)!\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\", // (3)!\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\", // (4)!\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    ...\n  }\n}\n
    1. The name of the API requirements version, for example \"1.2.0\", against which to validate this version of the API specification.
    2. Conformity evaluation has passed, the resource is conformant.
    3. Conformity evaluation has not passed, the resource is not conformant.
    4. Conformity evaluation is not applicable to the resource.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"188c9c2c-ea9e-48fa-8423-5e8e2f60161c\",\n  \"requirementsVersion\": \"1.2.0\",\n  \"rankingLevel\": \"OPEN_API\",\n  \"rankings\": {\n    \"OPEN_API\": {\n      \"score\": 27,\n      \"maximumScore\": 31\n    },\n    \"TECHNICALLY_STANDARDIZED_API\": {\n      \"score\": 6,\n      \"maximumScore\": 11\n    },\n    \"FULLY_STANDARDIZED_API\": {\n      \"score\": 2,\n      \"maximumScore\": 6\n    }\n  },\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    ...\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#set-api-specification-main-version","title":"Set API specification main version","text":"RequestResponse 
    PATCH https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"mainVersionId\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\"\n}\n
    HTTP/1.1 20O OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"fe30bf05-de07-4556-9b17-1f82d62fe45f\",\n  \"name\": \"Verzamelen Huisartsgegevens\",\n  \"description\": \"Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n  \"organization\": {\n    \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"name\": \"Nictiz\"\n  },\n  \"architecturalStyle\": \"REST\",\n  \"mainVersionId\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\",\n  \"mainVersion\": {\n    \"id\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\",\n    \"name\": \"2.0\",\n    \"description\": \"Verzamelen Huisartsgegevens 2.0\",\n    \"publishTime\": \"2020-09-02T00:00:00.000Z\",\n    \"semVer\": {\n      \"major\": 2,\n      \"minor\": 0,\n      \"patch\": 0\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"urls\": [\n      {\n        \"id\": \"37bfbf71-570c-45c1-9fbf-7e5f63db61b8\",\n        \"type\": \"FUNCTIONAL_DESIGN\",\n        \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens\"\n      },\n      {\n        \"id\": \"8a87c023-aabb-454f-8e1a-3443a13f11e2\",\n        \"type\": \"TECHNICAL_DESIGN\",\n        \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data\"\n      }\n    ],\n    \"lastDeclarationOfConformity\": {\n      \"id\": \"188c9c2c-ea9e-48fa-8423-5e8e2f60161c\",\n      \"requirementsVersion\": \"1.2.0\",\n      \"rankingLevel\": \"OPEN_API\",\n      \"rankings\": {\n        \"OPEN_API\": {\n          \"score\": 27,\n          \"maximumScore\": 31\n        },\n        \"TECHNICALLY_STANDARDIZED_API\": {\n          \"score\": 6,\n          \"maximumScore\": 11\n        },\n        \"FULLY_STANDARDIZED_API\": {\n          \"score\": 2,\n          \"maximumScore\": 6\n        }\n      }\n    }\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/getting-api-requirements/","title":"Getting API requirements","text":""},{"location":"learn/apis/getting-api-requirements/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  API-REQUIREMENTS-VERSION ||--o{ API-REQUIREMENT : contains

    Info

    "},{"location":"learn/apis/getting-api-requirements/#get-api-requirements","title":"Get API requirements","text":"

    List all must-have requirements for API specifications with the REST architectural style:

    RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/api-requirements-versions/1.2.0/api-requirements\n    ?filter=and(\n        eq(requirementLevel,\"MUST\"), // (1)!\n        any(perspectiveTypes,eq($it,\"API_SPECIFICATION\")), // (2)!\n        any(architecturalStyles,eq($it,\"REST\")), // (3)!\n    ) HTTP/1.1\n
    1. The requirement level must be equal to \"MUST\".
    2. The perspective types must include \"API_SPECIFICATION\".
    3. The architectural styles must include \"REST\".
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n\ufeff[\n  {\n    \"id\": \"516033cb-06a4-4312-8874-dfbed689760f\", // (1)!\n    \"code\": \"SD001\",\n    \"description\": \"API documentation MUST be publicly and freely available\",\n    \"url\": \"https://nictiz.github.io/api-requirements-docs/v1.2.0/api-specification-and-documentation/#sd001-api-documentation-must-be-publicly-and-freely-available\",\n    \"requirementLevel\": \"MUST\",\n    \"score\": 1,\n    \"category\": \"API_SPECIFICATION_AND_DOCUMENTATION\",\n    \"roles\": [ // (2)!\n      \"API_SPECIFIER\"\n    ],\n    \"perspectiveTypes\": [ // (3)!\n      \"API_SPECIFICATION\"\n    ],\n    \"architecturalStyles\": [ // (4)!\n      \"REST\",\n      \"SOAP\",\n      \"GRAPHQL\",\n      \"ODATA\",\n      \"GRPC\",\n      \"OTHER\"\n    ],\n    \"standardizationLevels\": [ // (5)!\n      \"OPEN_API\",\n      \"TECHNICALLY_STANDARDIZED_API\",\n      \"FULLY_STANDARDIZED_API\"\n    ]\n  },\n  ...\n]\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API requirement by the API server.
    2. The roles that apply to the API requirement.
    3. The perspective types that apply to the API requirement.
    4. The architectural styles that apply to the API requirement.
    5. The standardization levels that apply to the API requirement.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/","title":"Organizations","text":"

    Learn how to add your organization to the API Library for Dutch Healthcare and invite users to collaborate on maintaining your organization's profile and contributions.

    "},{"location":"learn/organizations/#resources","title":"Resources","text":""},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/","title":"Accepting an invitation to join an organization","text":""},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  USER ||--o{ INVITATION : contains\n  USER ||--o{ MEMBERSHIP : contains\n  INVITATION ||..|| ORGANIZATION : references\n  MEMBERSHIP ||..|| ORGANIZATION : references

    Info

    "},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/#get-pending-invitations","title":"Get pending invitations","text":"RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/users/me/invitations?filter=eq(status,\"PENDING\") HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n\ufeff[\n  {\n    \"id\": \"88411780-1d25-4bc3-86a5-f2f901d9a900\",\n    \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"organization\": {\n      \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n      \"name\": \"Nictiz\"\n    },\n    \"emailAddress\": \"john.doe@nictiz.nl\",\n    \"status\": \"PENDING\"\n  }\n]\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/#accept-pending-invitation","title":"Accept pending invitation","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/users/me/invitations/88411780-1d25-4bc3-86a5-f2f901d9a900:accept HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"88411780-1d25-4bc3-86a5-f2f901d9a900\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n  \"organization\": {\n    \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"name\": \"Nictiz\"\n  },\n  \"emailAddress\": \"john.doe@nictiz.nl\",\n  \"status\": \"ACCEPTED\",\n  \"responseTime\": \"2024-04-10T15:00:00.000Z\" // (1)!\n}\n
    1. The date and time (formatted as per ISO 8601) at which the user responded to the invitation.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/adding-an-organization/","title":"Adding an organization","text":""},{"location":"learn/organizations/adding-an-organization/#add-organization","title":"Add organization","text":"

    This section guides you through the process of adding your organization to the API Library for Dutch Healthcare via our API.

    Info

    You can set the URL of your organization on GitHub or GitLab using the githubUrl and gitlabUrl properties. This URL will be used to retrieve the organization's avatar and display it on the organization page in the API Library for Dutch Healthcare.

    RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/organizations HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"name\": \"Nictiz\", // (1)!\n  \"description\": \"Nictiz is the Dutch competence center for electronic exchange of health and care information.\",\n  \"website\": \"https://nictiz.nl/\",\n  \"githubUrl\": \"https://github.com/Nictiz\", // (2)!\n  \"emailAddress\": \"info@nictiz.nl\",\n  \"phoneNumber\": \"+31 (0)70 317 3450\",\n  \"address\": {\n    \"street\": \"Oude Middenweg\",\n    \"houseNumber\": 55, // (3)!\n    \"addressLine2\": \"Office building Palazzo Giardino\",\n    \"postalCode\": \"2491 AC\",\n    \"city\": \"The Hague\",\n    \"stateOrRegion\": \"South Holland\",\n    \"country\": \"NL\"\n  }\n}\n
    1. The name of the organization, must be unique.
    2. The URL of the organization on GitHub. For GitLab, use the gitlabUrl property.
    3. To set the house number addition (for example, 'A'), use the houseNumberAddition property.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\", // (1)!\n  \"name\": \"Nictiz\",\n  \"description\": \"Nictiz is the Dutch competence center for electronic exchange of health and care information.\",\n  \"website\": \"https://nictiz.nl/\",\n  \"githubUrl\": \"https://github.com/Nictiz\",\n  \"emailAddress\": \"info@nictiz.nl\",\n  \"phoneNumber\": \"+31 (0)70 317 3450\",\n  \"address\": {\n    \"street\": \"Oude Middenweg\",\n    \"houseNumber\": 55,\n    \"addressLine2\": \"Office building Palazzo Giardino\",\n    \"postalCode\": \"2491 AC\",\n    \"city\": \"The Hague\",\n    \"stateOrRegion\": \"South Holland\",\n    \"country\": \"NL\"\n  }\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the organization by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/inviting-a-user-to-an-organization/","title":"Inviting a user to an organization","text":""},{"location":"learn/organizations/inviting-a-user-to-an-organization/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  ORGANIZATION ||--o{ INVITATION : contains\n  ORGANIZATION ||--|{ MEMBERSHIP : contains\n  INVITATION ||..o| USER : references\n  MEMBERSHIP ||..|| USER : references

    Info

    "},{"location":"learn/organizations/inviting-a-user-to-an-organization/#add-invitation","title":"Add invitation","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/organizations/4a7c2c17-6514-46f8-aa05-6a22fb18b4ad/invitations HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"emailAddress\": \"john.doe@nictiz.nl\" // (1)!\n}\n
    1. The email address of the user. Each organization can have only one pending invitation per email address, and the email address cannot belong to an existing member.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"88411780-1d25-4bc3-86a5-f2f901d9a900\", // (1)!\n  \"emailAddress\": \"john.doe@nictiz.nl\",\n  \"status\": \"PENDING\" // (2)!\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the invitation by the API server.
    2. The status of the invitation. For example, \"PENDING\" or \"ACCEPTED\".

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/","title":"Standards","text":"

    Learn how to add your communication standard and its versions to the API Library for Dutch Healthcare.

    "},{"location":"learn/standards/#resources","title":"Resources","text":""},{"location":"learn/standards/adding-a-communication-standard/","title":"Adding a communication standard","text":""},{"location":"learn/standards/adding-a-communication-standard/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  COMMUNICATION-STANDARD ||--o{ VERSION : contains\n  COMMUNICATION-STANDARD }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/standards/adding-a-communication-standard/#add-communication-standard","title":"Add communication standard","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/communication-standards HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"FHIR\", // (1)!\n  \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n  \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\", // (2)!\n  \"url\": \"https://hl7.org/fhir/\"\n}\n
    1. The name of the communication standard, must be unique for this organization (see \"organizationId\").
    2. The UUID of the organization that maintains the communication standard.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\", // (1)!\n  \"name\": \"FHIR\",\n  \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n  \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n  \"organization\": {\n    \"id\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n    \"name\": \"HL7 Nederland\"\n  },\n  \"url\": \"https://hl7.org/fhir/\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the communication standard by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/adding-a-communication-standard/#add-communication-standard-version","title":"Add communication standard version","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/communication-standard-versions HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"R5\", // (1)!\n  \"description\": \"FHIR Specification 5.0.0\",\n  \"communicationStandardId\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\", // (2)!\n  \"publishTime\": \"2023-03-26T12:00:00.0000000Z\", // (3)!\n  \"semVer\": { // (4)!\n    \"major\": 5,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://hl7.org/fhir/R5\"\n}\n
    1. The name of the communication standard version, must be unique for this communication standard (see \"communicationStandardId\").
    2. The UUID of the communication standard to which this version belongs.

    3. The date and time (formatted as per ISO 8601) at which the communication standard version was published. In other words, the date and time at which this version was first made available by the organization that maintains the communication standard.

      Note: publishTime is not to be used for the date and time at which this version is published in the API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item and can be accessed via read-only property createTime.

    4. The SemVer version information. Additional properties for pre-release (\"preRelease\") and build metadata (\"build\") are available.

    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\", // (1)!\n  \"name\": \"R5\",\n  \"description\": \"FHIR Specification 5.0.0\",\n  \"communicationStandardId\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n  \"communicationStandard\": {\n    \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n    \"name\": \"FHIR\"\n  },\n  \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n  \"semVer\": {\n    \"major\": 5,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://hl7.org/fhir/R5\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the communication standard version by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/adding-a-communication-standard/#set-communication-standard-main-version","title":"Set communication standard main version","text":"RequestResponse 
    PATCH https://api.zorgapis.nl/v1beta1/communication-standards/05d8de10-1932-4e7f-badf-655c1a82fcc3 HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"mainVersionId\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\"\n}\n
    HTTP/1.1 20O OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n  \"name\": \"FHIR\",\n  \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n  \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n  \"organization\": {\n    \"id\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n    \"name\": \"HL7 Nederland\"\n  },\n  \"url\": \"https://hl7.org/fhir/\",\n  \"mainVersionId\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n  \"mainVersion\": {\n    \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n    \"name\": \"R5\",\n    \"description\": \"FHIR Specification 5.0.0\",\n    \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 5,\n      \"minor\": 0,\n      \"patch\": 0\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://hl7.org/fhir/R5\"\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/getting-communication-standards/","title":"Getting communication standards","text":""},{"location":"learn/standards/getting-communication-standards/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  COMMUNICATION-STANDARD ||--o{ VERSION : contains\n  COMMUNICATION-STANDARD }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/standards/getting-communication-standards/#get-communication-standards","title":"Get communication standards","text":"RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/communication-standards HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\", // (1)!\n    \"name\": \"FHIR\",\n    \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n    \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n    \"organization\": {\n      \"id\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n      \"name\": \"HL7 Nederland\"\n    },\n    \"url\": \"https://hl7.org/fhir/\",\n    \"mainVersionId\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\", // (2)!\n    \"mainVersion\": {\n      \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n      \"name\": \"R5\",\n      \"description\": \"FHIR Specification 5.0.0\",\n      \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n      \"semVer\": {\n        \"major\": 5,\n        \"minor\": 0,\n        \"patch\": 0\n      },\n      \"lifecycleState\": \"PUBLISHED\",\n      \"url\": \"https://hl7.org/fhir/R5\"\n    }\n  },\n  ...\n]\n
    1. The UUID of the communication standard.
    2. The UUID of the main version.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/getting-communication-standards/#get-communication-standard-versions","title":"Get communication standard versions","text":"

    List all versions for the communication standard with id \"05d8de10-1932-4e7f-badf-655c1a82fcc3\":

    RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/communication-standard-versions\n    ?filter=eq(communicationStandardId,\"05d8de10-1932-4e7f-badf-655c1a82fcc3\") HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n    \"name\": \"R5\",\n    \"description\": \"FHIR Specification 5.0.0\",\n    \"communicationStandardId\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n    \"communicationStandard\": {\n      \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n      \"name\": \"FHIR\"\n    },\n    \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 5,\n      \"minor\": 0,\n      \"patch\": 0\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://hl7.org/fhir/R5\"\n  },\n  ...\n]\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/snippets/communication-standard-entity-relationship-diagram/","title":"Communication standard entity relationship diagram","text":"
    erDiagram\n  COMMUNICATION-STANDARD ||--o{ VERSION : contains\n  COMMUNICATION-STANDARD }o..|| ORGANIZATION : references

    Info

    "},{"location":"play/","title":"ZorgAPIs sandbox","text":"

    Explore and experiment with our sandbox API, a secure playground for developers to test functionalities, debug code, and innovate without disrupting live data or environments.

    Info

    When exploring our sandbox API, fork our Postman Collection and select Get New Access Token in the Authorization tab of a request. Postman will automatically populate the relevant parts of the request. To learn more, go to Authenticate with OAuth 2.0 authentication in Postman.

    Register Log out

    Note

    When you fork our Postman Collection, use the environment selector to set Sandbox as the active environment.

    "},{"location":"play/#resources","title":"Resources","text":"

    Here you will find all the tools and assets you need to get started with the ZorgAPIs API.

    "},{"location":"blog/archive/2024/","title":"2024","text":""},{"location":"blog/category/general/","title":"General","text":""}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introduction to ZorgAPIs","text":"

    Effective Application Programming Interfaces (APIs) achieve interoperability and are therefore of strategic importance for an Integrated Health Information System. That is why Nictiz, in consultation with the Ministry of Health, Welfare and Sport and stakeholders, has developed an API strategy for Dutch healthcare. This strategy focuses on the development of APIs towards fully standardized data exchanges. The API Library promotes the findability of APIs that meet the requirements at a particular level of standardization.

    "},{"location":"#resources","title":"Resources","text":""},{"location":"#documentation","title":"Documentation","text":"

    Explore our documentation to gain a deeper understanding of how to harness the power of APIs in healthcare to enhance data exchange, streamline processes, and foster innovation.

    "},{"location":"nictiz/","title":"Nictiz","text":"

    Nictiz is the Dutch competence center for electronic exchange of health and care information. Nictiz develops and maintains standards for digital information management, ensuring that healthcare information can be recorded and exchanged in an unambiguous manner. To this end Nictiz maintains close cooperation with the international Standardization Organizations: IHE, HL7, SNOMED International, PCH Alliance, CEN/NEN.

    "},{"location":"nictiz/#knowledge","title":"Knowledge","text":"

    There is a vast body of knowledge about digital information management in healthcare. As a competence center, Nictiz considers sharing this knowledge an important part of its mission.

    "},{"location":"blog/","title":"Blog","text":""},{"location":"blog/2024/07/18/adding-an-avatar-to-your-organization/","title":"Adding an avatar to your organization","text":"

    ZorgAPIs API version 0.3.2 is released, which brings a new and simple way to add an avatar to your organization's page in the API Library for Dutch Healthcare.

    As part of our continuous efforts to enhance user experience, we have added the githubUrl and gitlabUrl properties to the Organization schema. These URLs will be used to retrieve the organization's avatar and display it on your page in the API Library for Dutch Healthcare.

    With this update, you can simply link your organization's GitHub or GitLab profile. The system will automatically fetch and display the avatar from these profiles, enhancing your organization's brand presence within the API Library and making it easier for users to identify and engage with your APIs.

    We encourage you to update your organization's profile and take advantage of this new functionality. We have updated our documentation to guide you through the process of adding or updating your organization details.

    "},{"location":"blog/2024/08/14/discover-the-new-api-specification-page/","title":"Discover the new API specification page","text":"

    We are excited to announce that the API specification page is now live on the API Library for Dutch Healthcare! This new feature allows you to easily explore and access API documentation.

    On this page, you will find essential API information, including the architectural style, version history, standardization level, lifecycle state and release date. Additionally, you will find links to various documentation resources, such as the functional design, technical design, or OpenAPI Specification (OAS).

    "},{"location":"blog/2024/08/14/discover-the-new-api-specification-page/#early-adopters","title":"Early adopters","text":"

    We are especially proud to highlight two early adopters of the API strategy for Dutch Healthcare: Open Health Hub and ChipSoft. Open Health Hub has successfully published their FHIR Questionnaire API, while ChipSoft has published their Zorgplatform Workflow API. By doing so, both companies have taken significant steps in advancing API standardization and interoperability in Dutch healthcare, setting a strong example for others to follow.

    "},{"location":"blog/2024/08/14/discover-the-new-api-specification-page/#get-involved","title":"Get involved","text":"

    Visit the API Library for Dutch Healthcare today to explore this new feature, learn more about these pioneering APIs, and see how the API Library continues to evolve with contributions from leading industry players. But most importantly, get involved \u2013 publish your organization and API information using our API so others can discover and adopt your solutions.

    A big thank you to everyone involved.

    "},{"location":"code/","title":"Code using ZorgAPIs","text":"

    Because ZorgAPIs is a community effort for the betterment of health data exchange, we welcome you to create and share tools that help users get started with ZorgAPIs API.

    "},{"location":"learn/","title":"Learn","text":"

    ZorgAPIs API enables the creation of applications that can interact with the API Library for Dutch Healthcare, such as retrieving API requirements, creating and managing organizations and API specifications, or publishing declarations of conformity.

    Tip

    Utilize our sandbox API to ensure your integrations are seamless and robust before publishing data to the production environment.

    "},{"location":"learn/#getting-started","title":"Getting started","text":""},{"location":"learn/authorizing-a-request/","title":"Authorizing a request","text":"

    ZorgAPIs API uses OAuth 2.0 to ensure that client requests access data securely. With OAuth 2.0, you first retrieve an access token for the API, then use that token to authenticate future requests.

    Info

    When exploring our API, fork our Postman Collection and select Get New Access Token in the Authorization tab of a request. Postman will automatically populate the relevant parts of the request. To learn more, go to Authenticate with OAuth 2.0 authentication in Postman.

    Register Log out

    "},{"location":"learn/authorizing-a-request/#how-the-authorization-code-flow-works","title":"How the Authorization Code flow works","text":"

    The example diagram below illustrates the interactions that occur during the OAuth 2.0 Authorization Code Grant flow.

    sequenceDiagram\n  participant user as User\n  participant client as Application\n  participant idp as Authorization server\n  participant api as API\n  autonumber\n\n  activate user\n  user->>client: Access\n  activate client\n  client->>idp: Request authorization\n  deactivate client\n  activate idp\n  idp->>user: Show sign in page\n  user->>idp: Sign in with credentials\n  deactivate user\n  idp->>client: Issue authorization code\n  activate client\n  client->>idp: Request token\n  idp->>idp: Validate request\n  idp->>client: Return access token\n  deactivate idp\n  client->>api: Call API with access token\n  activate api\n  api->>client: Return data\n  deactivate api\n  client->>user: Display data\n  deactivate client
    1. A user tries to access the application (the client)

    2. The application redirects to the authorization server's auth endpoint 

      https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/auth\n    ?response_type=code\n    &client_id=<client-id> <!-- (1)! -->\n    &redirect_uri=<redirect-uri> <!-- (2)! -->\n    &scope=<scopes> <!-- (3)! -->\n    &state=<state>\n

      1. For example, zorgapis.postman.
      2. For example, https://oauth.pstmn.io/v1/browser-callback.
      3. For example, api-requirements-versions:read.

    3. The authorization server shows the sign in page

    4. The user signs in with its credentials
    5. The authorization server issues an authorization code to the application

    6. The application requests an access token from the token endpoint 

      POST https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/token\n    ?grant_type=authorization_code\n    &client_id=<client-id>\n    &client_secret=<secret>\n    &code=<auth-code>\n    &redirect_uri=<redirect-uri>\n

    7. The authorization server validates the request

    8. The authorization server returns the access token
    9. The application calls a protected API endpoint using the access token
    10. The API validates the access token and returns the data
    11. The application displays the data to the user
    "},{"location":"learn/agreements/","title":"Agreements","text":"

    Learn how to add your trust framework and its versions to the API Library for Dutch Healthcare.

    "},{"location":"learn/agreements/#resources","title":"Resources","text":""},{"location":"learn/agreements/adding-a-trust-framework/","title":"Adding a trust framework","text":""},{"location":"learn/agreements/adding-a-trust-framework/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  TRUST-FRAMEWORK ||--o{ VERSION : contains\n  TRUST-FRAMEWORK }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/agreements/adding-a-trust-framework/#add-trust-framework","title":"Add trust framework","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"MedMij Afsprakenstelsel\", // (1)!\n  \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n  \"organizationId\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\", // (2)!\n  \"url\": \"https://afsprakenstelsel.medmij.nl/\"\n}\n
    1. The name of the trust framework, must be unique for this organization (see \"organizationId\").
    2. The UUID of the organization that maintains the trust framework.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"3d443c34-24a4-4640-bfe5-822627af76e2\", // (1)!\n  \"name\": \"MedMij Afsprakenstelsel\",\n  \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n  \"organizationId\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n  \"organization\": {\n    \"id\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n    \"name\": \"Stichting MedMij\"\n  },\n  \"url\": \"https://afsprakenstelsel.medmij.nl/\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the trust framework by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/adding-a-trust-framework/#add-trust-framework-version","title":"Add trust framework version","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/trust-framework-versions HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"2.2.2 Verplicht\", // (1)!\n  \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n  \"trustFrameworkId\": \"3d443c34-24a4-4640-bfe5-822627af76e2\", // (2)!\n  \"publishTime\": \"2024-09-10T12:00:00.0000000Z\", // (3)!\n  \"semVer\": { // (4)!\n    \"major\": 2,\n    \"minor\": 2,\n    \"patch\": 2\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/\"\n}\n
    1. The name of the trust framework version, must be unique for this trust framework (see \"trustFrameworkId\").
    2. The UUID of the trust framework to which this version belongs.

    3. The date and time (formatted as per ISO 8601) at which the trust framework version was published. In other words, the date and time at which this version was first made available by the organization that maintains the trust framework.

      Note: publishTime is not to be used for the date and time at which this version is published in the API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item and can be accessed via read-only property createTime.

    4. The SemVer version information. Additional properties for pre-release (\"preRelease\") and build metadata (\"build\") are available.

    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\", // (1)!\n  \"name\": \"2.2.2 Verplicht\",\n  \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n  \"trustFrameworkId\": \"3d443c34-24a4-4640-bfe5-822627af76e2\",\n  \"trustFramework\": {\n    \"id\": \"3d443c34-24a4-4640-bfe5-822627af76e2\",\n    \"name\": \"MedMij Afsprakenstelsel\"\n  },\n  \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n  \"semVer\": {\n    \"major\": 2,\n    \"minor\": 2,\n    \"patch\": 2\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the trust framework version by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/adding-a-trust-framework/#set-trust-framework-main-version","title":"Set trust framework main version","text":"RequestResponse 
    PATCH https://api.zorgapis.nl/v1beta1/trust-frameworks/3d443c34-24a4-4640-bfe5-822627af76e2 HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"mainVersionId\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\"\n}\n
    HTTP/1.1 20O OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"3d443c34-24a4-4640-bfe5-822627af76e2\",\n  \"name\": \"MedMij Afsprakenstelsel\",\n  \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n  \"organizationId\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n  \"organization\": {\n    \"id\": \"606becf9-bfd6-4ed1-aadc-7e478af8e456\",\n    \"name\": \"Stichting MedMij\"\n  },\n  \"url\": \"https://afsprakenstelsel.medmij.nl/\",\n  \"mainVersionId\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\",\n  \"mainVersion\": {\n    \"id\": \"2389dc34-2626-4ba3-b4f9-8ad649137d55\",\n    \"name\": \"2.2.2 Verplicht\",\n    \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n    \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 2,\n      \"minor\": 2,\n      \"patch\": 2\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/\"\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/getting-trust-frameworks/","title":"Getting trust frameworks","text":""},{"location":"learn/agreements/getting-trust-frameworks/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  TRUST-FRAMEWORK ||--o{ VERSION : contains\n  TRUST-FRAMEWORK }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/agreements/getting-trust-frameworks/#get-trust-frameworks","title":"Get trust frameworks","text":"RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\", // (1)!\n    \"name\": \"MedMij Afsprakenstelsel\",\n    \"description\": \"Het MedMij Afsprakenstelsel draagt eraan bij dat persoonsgebonden, gevoelige en vertrouwelijke gezondheidsgegevens op een veilige en gebruiksvriendelijke wijze uitgewisseld kunnen worden tussen persoonlijke gezondheidsomgevingen en aanbieders.\",\n    \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"organization\": {\n      \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n      \"name\": \"Stichting MedMij\"\n    },\n    \"url\": \"https://afsprakenstelsel.medmij.nl/\",\n    \"mainVersionId\": \"78ca8495-a4f4-4b41-b97b-c912c2e96450\", // (2)!\n    \"mainVersion\": {\n      \"id\": \"78ca8495-a4f4-4b41-b97b-c912c2e96450\",\n      \"name\": \"2.2.2 Verplicht\",\n      \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n      \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n      \"semVer\": {\n        \"major\": 2,\n        \"minor\": 2,\n        \"patch\": 2\n      },\n      \"lifecycleState\": \"PUBLISHED\",\n      \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht\"\n    }\n  },\n  ...\n]\n
    1. The UUID of the trust framework.
    2. The UUID of the main version.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/getting-trust-frameworks/#get-trust-framework-versions","title":"Get trust framework versions","text":"

    List all versions for the trust framework with id \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\":

    RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/trust-framework-versions\n    ?filter=eq(trustFrameworkId,\"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\") HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"78ca8495-a4f4-4b41-b97b-c912c2e96450\",\n    \"name\": \"2.2.2 Verplicht\",\n    \"description\": \"Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.\",\n    \"trustFrameworkId\": \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\",\n    \"trustFramework\": {\n      \"id\": \"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae\",\n      \"name\": \"MedMij Afsprakenstelsel\"\n    },\n    \"publishTime\": \"2024-09-10T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 2,\n      \"minor\": 2,\n      \"patch\": 2\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht\"\n  },\n  ...\n]\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/agreements/snippets/trust-framework-entity-relationship-diagram/","title":"Trust framework entity relationship diagram","text":"
    erDiagram\n  TRUST-FRAMEWORK ||--o{ VERSION : contains\n  TRUST-FRAMEWORK }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/apis/","title":"APIs","text":"

    Learn how to add your API specification and its versions to the API Library for Dutch Healthcare.

    "},{"location":"learn/apis/#resources","title":"Resources","text":""},{"location":"learn/apis/adding-an-api-specification/","title":"Adding an API specification","text":""},{"location":"learn/apis/adding-an-api-specification/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  API-SPECIFICATION ||--o{ VERSION : contains\n  VERSION ||--o{ DECLARATION-OF-CONFORMITY : contains\n  API-SPECIFICATION }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/apis/adding-an-api-specification/#add-api-specification","title":"Add API specification","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/api-specifications HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"name\": \"Verzamelen Huisartsgegevens\", // (1)!\n  \"description\": \"Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\", // (2)!\n  \"architecturalStyle\": \"REST\" // (3)!\n}\n
    1. The name of the API specification, must be unique for this organization (see \"organizationId\").
    2. The UUID of the organization that maintains the API specification.
    3. The architectural style of the API specification, and therefore of all associated versions. For example, \"REST\" or \"SOAP\".
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"fe30bf05-de07-4556-9b17-1f82d62fe45f\", // (1)!\n  \"name\": \"Verzamelen Huisartsgegevens\",\n  \"description\": \"Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n  \"organization\": {\n    \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"name\": \"Nictiz\"\n  },\n  \"architecturalStyle\": \"REST\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API specification by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#add-api-specification-version","title":"Add API specification version","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"name\": \"2.0\", // (1)!\n  \"description\": \"Verzamelen Huisartsgegevens 2.0\",\n  \"publishTime\": \"2020-09-02T00:00:00.000Z\", // (2)!\n  \"semVer\": { // (3)!\n    \"major\": 2,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"urls\": [\n    {\n      \"type\": \"FUNCTIONAL_DESIGN\", // (4)!\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens\"\n    },\n    {\n      \"type\": \"TECHNICAL_DESIGN\",\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data\"\n    }\n  ]\n}\n
    1. The name of the API specification version, must be unique for this API specification.

    2. The date and time (formatted as per ISO 8601) at which the API specification version was published. In other words, the date and time at which this version was first made available by the organization that maintains the API specification.

      Note: publishTime is not to be used for the date and time at which this version is published in the API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item and can be accessed via read-only property createTime.

    3. The SemVer version information. Additional properties for pre-release (\"preRelease\") and build metadata (\"build\") are available.

    4. The URL type, for example, \"OPENAPI_SPECIFICATION\".
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\", // (1)!\n  \"name\": \"2.0\",\n  \"description\": \"Verzamelen Huisartsgegevens 2.0\",\n  \"publishTime\": \"2020-09-02T00:00:00.000Z\",\n  \"semVer\": {\n    \"major\": 2,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"urls\": [\n    {\n      \"id\": \"37bfbf71-570c-45c1-9fbf-7e5f63db61b8\", // (2)!\n      \"type\": \"FUNCTIONAL_DESIGN\",\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens\"\n    },\n    {\n      \"id\": \"8a87c023-aabb-454f-8e1a-3443a13f11e2\",\n      \"type\": \"TECHNICAL_DESIGN\",\n      \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data\"\n    }\n  ]\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API specification version by the API server.
    2. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API specification version URL by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#add-declaration-of-conformity","title":"Add declaration of conformity","text":"

    This section guides you through the process of validating your API specification against the requirements for APIs in Dutch Healthcare. As part of this process, you will perform a self-assessment to determine whether your API specification is conformant.

    "},{"location":"learn/apis/adding-an-api-specification/#the-importance-of-transparency","title":"The importance of transparency","text":"

    Transparency is a key aspect of this process. By making the results of your declaration of conformity publicly available, we ensure an environment of openness and accountability. Suppliers are encouraged to submit accurate results, knowing that their declarations will be published in the API Library for Dutch Healthcare. Results will be visible to everyone and can be independently verified based on the provided evidence.

    Warning

    You must provide evidence supporting compliance claims. Detailed documentation helps maintain the integrity and credibility of your declaration.

    "},{"location":"learn/apis/adding-an-api-specification/#declarations-are-immutable","title":"Declarations are immutable","text":"

    It is important to note that a declaration of conformity cannot be changed after it has been submitted. Similar to a git commit command, a new and permanent snapshot of the API specification's current rankings and standardization level is recorded into your history.

    Info

    Although you cannot alter a submitted declaration, you can always add new declarations to reflect updates or changes. The most recently submitted declaration will be used to display your ranking levels in the API Library for Dutch Healthcare.

    "},{"location":"learn/apis/adding-an-api-specification/#providing-evidence","title":"Providing evidence","text":"

    To support your compliance with standards, specifications, guidelines, practices, policies, or laws, you must provide evidence. This may include URLs to official third-party validation reports or audits (see SD010).

    The remarks field is available for you to provide evidence for compliance claims or to explain why specific requirements may not apply to your API specification.

    Note

    Markdown is supported for the remarks field. You can use Markdown syntax to format text, include links and more to enhance the readability and organization of your remarks.

    "},{"location":"learn/apis/adding-an-api-specification/#architectural-styles","title":"Architectural styles","text":"

    When adding a declaration of conformity, it is crucial te recognize that certain requirements may only apply to specific architectural styles. Each architectural style, such as REST, SOAP, GraphQL, OData, or gRPC, has its own unique set of requirements. This approach ensures that rankings are meaningful and consistent, allowing for a fair comparison between APIs that share the same architectural principles.

    Info

    You set the architectural style when adding an API specification. This architectural style will apply to the API specification and all of its versions.

    When you publish a declaration of conformity, you must use the set of requirements specific to the architectural style you selected when adding the API specification.

    Note

    If an expected requirement is missing, the ZorgAPIs API server will return an error. If an extra requirement is provided that is not part of the expected set, the API server will ignore it.

    We provide code snippets in JSON format to assist you in creating a declaration. These examples can be easily copied and used with our Postman Collection.

    Expand to show snippets RESTSOAPGraphQLODatagRPCOther 
    {\n  \"requirementsVersion\": \"1.2.0\", // (1)!\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR-R001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR-R002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-R001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-R002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-R003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    1. The name of the API requirements version, for example \"1.2.0\", against which to validate this version of the API specification.
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR-S001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-S001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC-S002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    {\n  \"requirementsVersion\": \"1.2.0\",\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    \"SD001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.015\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.016\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD001.017\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD004.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD005.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD009.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD010\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD011\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD013\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SD014\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DI001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM001.004\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM002.003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"LM008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"DR012\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC006\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC007\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC008\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"SC009\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003.002\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    },\n    \"IS003\": {\n      \"conformityType\": \"NOT_CONFORMANT\"\n    }\n  }\n}\n
    "},{"location":"learn/apis/adding-an-api-specification/#example","title":"Example","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/declarations-of-conformity HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"requirementsVersion\": \"1.2.0\", // (1)!\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\", // (2)!\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\", // (3)!\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\", // (4)!\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    ...\n  }\n}\n
    1. The name of the API requirements version, for example \"1.2.0\", against which to validate this version of the API specification.
    2. Conformity evaluation has passed, the resource is conformant.
    3. Conformity evaluation has not passed, the resource is not conformant.
    4. Conformity evaluation is not applicable to the resource.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"188c9c2c-ea9e-48fa-8423-5e8e2f60161c\",\n  \"requirementsVersion\": \"1.2.0\",\n  \"rankingLevel\": \"OPEN_API\",\n  \"rankings\": {\n    \"OPEN_API\": {\n      \"score\": 27,\n      \"maximumScore\": 31\n    },\n    \"TECHNICALLY_STANDARDIZED_API\": {\n      \"score\": 6,\n      \"maximumScore\": 11\n    },\n    \"FULLY_STANDARDIZED_API\": {\n      \"score\": 2,\n      \"maximumScore\": 6\n    }\n  },\n  \"requirements\": {\n    \"SD001\": {\n      \"conformityType\": \"CONFORMANT\",\n      \"remarks\": \"Provide evidence supporting compliance claims with standards, specifications, guidelines, practices, policies, or laws. Evidence may include URLs to official third-party validation reports or audits.\"\n    },\n    \"SD001.001\": {\n      \"conformityType\": \"NOT_CONFORMANT\",\n      \"remarks\": \"For example, explain why the resource does not meet this requirement.\"\n    },\n    \"SD001.002\": {\n      \"conformityType\": \"NOT_APPLICABLE\",\n      \"remarks\": \"For example, explain why this requirement does not apply to the resource.\"\n    },\n    ...\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#set-api-specification-main-version","title":"Set API specification main version","text":"RequestResponse 
    PATCH https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"mainVersionId\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\"\n}\n
    HTTP/1.1 20O OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"fe30bf05-de07-4556-9b17-1f82d62fe45f\",\n  \"name\": \"Verzamelen Huisartsgegevens\",\n  \"description\": \"Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n  \"organization\": {\n    \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"name\": \"Nictiz\"\n  },\n  \"architecturalStyle\": \"REST\",\n  \"mainVersionId\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\",\n  \"mainVersion\": {\n    \"id\": \"15261fd0-b292-45d9-b6b1-266cc922fb50\",\n    \"name\": \"2.0\",\n    \"description\": \"Verzamelen Huisartsgegevens 2.0\",\n    \"publishTime\": \"2020-09-02T00:00:00.000Z\",\n    \"semVer\": {\n      \"major\": 2,\n      \"minor\": 0,\n      \"patch\": 0\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"urls\": [\n      {\n        \"id\": \"37bfbf71-570c-45c1-9fbf-7e5f63db61b8\",\n        \"type\": \"FUNCTIONAL_DESIGN\",\n        \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens\"\n      },\n      {\n        \"id\": \"8a87c023-aabb-454f-8e1a-3443a13f11e2\",\n        \"type\": \"TECHNICAL_DESIGN\",\n        \"url\": \"https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data\"\n      }\n    ],\n    \"lastDeclarationOfConformity\": {\n      \"id\": \"188c9c2c-ea9e-48fa-8423-5e8e2f60161c\",\n      \"requirementsVersion\": \"1.2.0\",\n      \"rankingLevel\": \"OPEN_API\",\n      \"rankings\": {\n        \"OPEN_API\": {\n          \"score\": 27,\n          \"maximumScore\": 31\n        },\n        \"TECHNICALLY_STANDARDIZED_API\": {\n          \"score\": 6,\n          \"maximumScore\": 11\n        },\n        \"FULLY_STANDARDIZED_API\": {\n          \"score\": 2,\n          \"maximumScore\": 6\n        }\n      }\n    }\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#add-communication-standard-version","title":"Add communication standard version","text":"RequestResponse 
    PUT https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/communication-standard-versions/8ae84d7f-73e7-4f08-b839-c73c97128ada HTTP/1.1\n
    HTTP/1.1 204 No Content // (1)!\n
    1. After successfully adding the communication standard version, the API server responds with a 204 response with no body.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/adding-an-api-specification/#add-trust-framework-version","title":"Add trust framework version","text":"RequestResponse 
    PUT https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/trust-framework-versions/78ca8495-a4f4-4b41-b97b-c912c2e96450 HTTP/1.1\n
    HTTP/1.1 204 No Content // (1)!\n
    1. After successfully adding the trust framework version, the API server responds with a 204 response with no body.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/apis/getting-api-requirements/","title":"Getting API requirements","text":""},{"location":"learn/apis/getting-api-requirements/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  API-REQUIREMENTS-VERSION ||--o{ API-REQUIREMENT : contains

    Info

    "},{"location":"learn/apis/getting-api-requirements/#get-api-requirements","title":"Get API requirements","text":"

    List all must-have requirements for API specifications with the REST architectural style:

    RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/api-requirements-versions/1.2.0/api-requirements\n    ?filter=and(\n        eq(requirementLevel,\"MUST\"), // (1)!\n        any(perspectiveTypes,eq($it,\"API_SPECIFICATION\")), // (2)!\n        any(architecturalStyles,eq($it,\"REST\")), // (3)!\n    ) HTTP/1.1\n
    1. The requirement level must be equal to \"MUST\".
    2. The perspective types must include \"API_SPECIFICATION\".
    3. The architectural styles must include \"REST\".
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n\ufeff[\n  {\n    \"id\": \"516033cb-06a4-4312-8874-dfbed689760f\", // (1)!\n    \"code\": \"SD001\",\n    \"description\": \"API documentation MUST be publicly and freely available\",\n    \"url\": \"https://nictiz.github.io/api-requirements-docs/v1.2.0/api-specification-and-documentation/#sd001-api-documentation-must-be-publicly-and-freely-available\",\n    \"requirementLevel\": \"MUST\",\n    \"score\": 1,\n    \"category\": \"API_SPECIFICATION_AND_DOCUMENTATION\",\n    \"roles\": [ // (2)!\n      \"API_SPECIFIER\"\n    ],\n    \"perspectiveTypes\": [ // (3)!\n      \"API_SPECIFICATION\"\n    ],\n    \"architecturalStyles\": [ // (4)!\n      \"REST\",\n      \"SOAP\",\n      \"GRAPHQL\",\n      \"ODATA\",\n      \"GRPC\",\n      \"OTHER\"\n    ],\n    \"standardizationLevels\": [ // (5)!\n      \"OPEN_API\",\n      \"TECHNICALLY_STANDARDIZED_API\",\n      \"FULLY_STANDARDIZED_API\"\n    ]\n  },\n  ...\n]\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API requirement by the API server.
    2. The roles that apply to the API requirement.
    3. The perspective types that apply to the API requirement.
    4. The architectural styles that apply to the API requirement.
    5. The standardization levels that apply to the API requirement.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/","title":"Organizations","text":"

    Learn how to add your organization to the API Library for Dutch Healthcare and invite users to collaborate on maintaining your organization's profile and contributions.

    "},{"location":"learn/organizations/#resources","title":"Resources","text":""},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/","title":"Accepting an invitation to join an organization","text":""},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  USER ||--o{ INVITATION : contains\n  USER ||--o{ MEMBERSHIP : contains\n  INVITATION ||..|| ORGANIZATION : references\n  MEMBERSHIP ||..|| ORGANIZATION : references

    Info

    "},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/#get-pending-invitations","title":"Get pending invitations","text":"RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/users/me/invitations?filter=eq(status,\"PENDING\") HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n\ufeff[\n  {\n    \"id\": \"88411780-1d25-4bc3-86a5-f2f901d9a900\",\n    \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"organization\": {\n      \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n      \"name\": \"Nictiz\"\n    },\n    \"emailAddress\": \"john.doe@nictiz.nl\",\n    \"status\": \"PENDING\"\n  }\n]\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/accepting-an-invitation-to-join-an-organization/#accept-pending-invitation","title":"Accept pending invitation","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/users/me/invitations/88411780-1d25-4bc3-86a5-f2f901d9a900:accept HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"88411780-1d25-4bc3-86a5-f2f901d9a900\",\n  \"organizationId\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n  \"organization\": {\n    \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\",\n    \"name\": \"Nictiz\"\n  },\n  \"emailAddress\": \"john.doe@nictiz.nl\",\n  \"status\": \"ACCEPTED\",\n  \"responseTime\": \"2024-04-10T15:00:00.000Z\" // (1)!\n}\n
    1. The date and time (formatted as per ISO 8601) at which the user responded to the invitation.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/adding-an-organization/","title":"Adding an organization","text":""},{"location":"learn/organizations/adding-an-organization/#add-organization","title":"Add organization","text":"

    This section guides you through the process of adding your organization to the API Library for Dutch Healthcare via our API.

    Info

    You can set the URL of your organization on GitHub or GitLab using the githubUrl and gitlabUrl properties. This URL will be used to retrieve the organization's avatar and display it on the organization page in the API Library for Dutch Healthcare.

    RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/organizations HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"name\": \"Nictiz\", // (1)!\n  \"description\": \"Nictiz is the Dutch competence center for electronic exchange of health and care information.\",\n  \"website\": \"https://nictiz.nl/\",\n  \"githubUrl\": \"https://github.com/Nictiz\", // (2)!\n  \"emailAddress\": \"info@nictiz.nl\",\n  \"phoneNumber\": \"+31 (0)70 317 3450\",\n  \"address\": {\n    \"street\": \"Oude Middenweg\",\n    \"houseNumber\": 55, // (3)!\n    \"addressLine2\": \"Office building Palazzo Giardino\",\n    \"postalCode\": \"2491 AC\",\n    \"city\": \"The Hague\",\n    \"stateOrRegion\": \"South Holland\",\n    \"country\": \"NL\"\n  }\n}\n
    1. The name of the organization, must be unique.
    2. The URL of the organization on GitHub. For GitLab, use the gitlabUrl property.
    3. To set the house number addition (for example, 'A'), use the houseNumberAddition property.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"4a7c2c17-6514-46f8-aa05-6a22fb18b4ad\", // (1)!\n  \"name\": \"Nictiz\",\n  \"description\": \"Nictiz is the Dutch competence center for electronic exchange of health and care information.\",\n  \"website\": \"https://nictiz.nl/\",\n  \"githubUrl\": \"https://github.com/Nictiz\",\n  \"emailAddress\": \"info@nictiz.nl\",\n  \"phoneNumber\": \"+31 (0)70 317 3450\",\n  \"address\": {\n    \"street\": \"Oude Middenweg\",\n    \"houseNumber\": 55,\n    \"addressLine2\": \"Office building Palazzo Giardino\",\n    \"postalCode\": \"2491 AC\",\n    \"city\": \"The Hague\",\n    \"stateOrRegion\": \"South Holland\",\n    \"country\": \"NL\"\n  }\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the organization by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/organizations/inviting-a-user-to-an-organization/","title":"Inviting a user to an organization","text":""},{"location":"learn/organizations/inviting-a-user-to-an-organization/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  ORGANIZATION ||--o{ INVITATION : contains\n  ORGANIZATION ||--|{ MEMBERSHIP : contains\n  INVITATION ||..o| USER : references\n  MEMBERSHIP ||..|| USER : references

    Info

    "},{"location":"learn/organizations/inviting-a-user-to-an-organization/#add-invitation","title":"Add invitation","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/organizations/4a7c2c17-6514-46f8-aa05-6a22fb18b4ad/invitations HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"emailAddress\": \"john.doe@nictiz.nl\" // (1)!\n}\n
    1. The email address of the user. Each organization can have only one pending invitation per email address, and the email address cannot belong to an existing member.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"88411780-1d25-4bc3-86a5-f2f901d9a900\", // (1)!\n  \"emailAddress\": \"john.doe@nictiz.nl\",\n  \"status\": \"PENDING\" // (2)!\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the invitation by the API server.
    2. The status of the invitation. For example, \"PENDING\" or \"ACCEPTED\".

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/","title":"Standards","text":"

    Learn how to add your communication standard and its versions to the API Library for Dutch Healthcare.

    "},{"location":"learn/standards/#resources","title":"Resources","text":""},{"location":"learn/standards/adding-a-communication-standard/","title":"Adding a communication standard","text":""},{"location":"learn/standards/adding-a-communication-standard/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  COMMUNICATION-STANDARD ||--o{ VERSION : contains\n  COMMUNICATION-STANDARD }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/standards/adding-a-communication-standard/#add-communication-standard","title":"Add communication standard","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/communication-standards HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"FHIR\", // (1)!\n  \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n  \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\", // (2)!\n  \"url\": \"https://hl7.org/fhir/\"\n}\n
    1. The name of the communication standard, must be unique for this organization (see \"organizationId\").
    2. The UUID of the organization that maintains the communication standard.
    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\", // (1)!\n  \"name\": \"FHIR\",\n  \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n  \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n  \"organization\": {\n    \"id\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n    \"name\": \"HL7 Nederland\"\n  },\n  \"url\": \"https://hl7.org/fhir/\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the communication standard by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/adding-a-communication-standard/#add-communication-standard-version","title":"Add communication standard version","text":"RequestResponse 
    POST https://api.zorgapis.nl/v1beta1/communication-standard-versions HTTP/1.1\nContent-Type: application/json\n\n{\n  \"name\": \"R5\", // (1)!\n  \"description\": \"FHIR Specification 5.0.0\",\n  \"communicationStandardId\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\", // (2)!\n  \"publishTime\": \"2023-03-26T12:00:00.0000000Z\", // (3)!\n  \"semVer\": { // (4)!\n    \"major\": 5,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://hl7.org/fhir/R5\"\n}\n
    1. The name of the communication standard version, must be unique for this communication standard (see \"communicationStandardId\").
    2. The UUID of the communication standard to which this version belongs.

    3. The date and time (formatted as per ISO 8601) at which the communication standard version was published. In other words, the date and time at which this version was first made available by the organization that maintains the communication standard.

      Note: publishTime is not to be used for the date and time at which this version is published in the API Library for Dutch Healthcare. This value is set automatically by the API server upon creation of the item and can be accessed via read-only property createTime.

    4. The SemVer version information. Additional properties for pre-release (\"preRelease\") and build metadata (\"build\") are available.

    HTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n  \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\", // (1)!\n  \"name\": \"R5\",\n  \"description\": \"FHIR Specification 5.0.0\",\n  \"communicationStandardId\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n  \"communicationStandard\": {\n    \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n    \"name\": \"FHIR\"\n  },\n  \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n  \"semVer\": {\n    \"major\": 5,\n    \"minor\": 0,\n    \"patch\": 0\n  },\n  \"lifecycleState\": \"PUBLISHED\",\n  \"url\": \"https://hl7.org/fhir/R5\"\n}\n
    1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the communication standard version by the API server.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/adding-a-communication-standard/#set-communication-standard-main-version","title":"Set communication standard main version","text":"RequestResponse 
    PATCH https://api.zorgapis.nl/v1beta1/communication-standards/05d8de10-1932-4e7f-badf-655c1a82fcc3 HTTP/1.1\nContent-Type: application/json\n\n\ufeff{\n  \"mainVersionId\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\"\n}\n
    HTTP/1.1 20O OK\nContent-Type: application/json\n\n\ufeff{\n  \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n  \"name\": \"FHIR\",\n  \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n  \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n  \"organization\": {\n    \"id\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n    \"name\": \"HL7 Nederland\"\n  },\n  \"url\": \"https://hl7.org/fhir/\",\n  \"mainVersionId\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n  \"mainVersion\": {\n    \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n    \"name\": \"R5\",\n    \"description\": \"FHIR Specification 5.0.0\",\n    \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 5,\n      \"minor\": 0,\n      \"patch\": 0\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://hl7.org/fhir/R5\"\n  }\n}\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/getting-communication-standards/","title":"Getting communication standards","text":""},{"location":"learn/standards/getting-communication-standards/#entity-relationship-diagram","title":"Entity relationship diagram","text":"
    erDiagram\n  COMMUNICATION-STANDARD ||--o{ VERSION : contains\n  COMMUNICATION-STANDARD }o..|| ORGANIZATION : references

    Info

    "},{"location":"learn/standards/getting-communication-standards/#get-communication-standards","title":"Get communication standards","text":"RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/communication-standards HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\", // (1)!\n    \"name\": \"FHIR\",\n    \"description\": \"FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.\",\n    \"organizationId\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n    \"organization\": {\n      \"id\": \"a70590c6-06ce-4dba-9098-ed996335bdec\",\n      \"name\": \"HL7 Nederland\"\n    },\n    \"url\": \"https://hl7.org/fhir/\",\n    \"mainVersionId\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\", // (2)!\n    \"mainVersion\": {\n      \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n      \"name\": \"R5\",\n      \"description\": \"FHIR Specification 5.0.0\",\n      \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n      \"semVer\": {\n        \"major\": 5,\n        \"minor\": 0,\n        \"patch\": 0\n      },\n      \"lifecycleState\": \"PUBLISHED\",\n      \"url\": \"https://hl7.org/fhir/R5\"\n    }\n  },\n  ...\n]\n
    1. The UUID of the communication standard.
    2. The UUID of the main version.

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/getting-communication-standards/#get-communication-standard-versions","title":"Get communication standard versions","text":"

    List all versions for the communication standard with id \"05d8de10-1932-4e7f-badf-655c1a82fcc3\":

    RequestResponse 
    GET https://api.zorgapis.nl/v1beta1/communication-standard-versions\n    ?filter=eq(communicationStandardId,\"05d8de10-1932-4e7f-badf-655c1a82fcc3\") HTTP/1.1\n
    HTTP/1.1 200 OK\nContent-Type: application/json\n\n[\n  {\n    \"id\": \"8ae84d7f-73e7-4f08-b839-c73c97128ada\",\n    \"name\": \"R5\",\n    \"description\": \"FHIR Specification 5.0.0\",\n    \"communicationStandardId\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n    \"communicationStandard\": {\n      \"id\": \"05d8de10-1932-4e7f-badf-655c1a82fcc3\",\n      \"name\": \"FHIR\"\n    },\n    \"publishTime\": \"2023-03-26T12:00:00.0000000Z\",\n    \"semVer\": {\n      \"major\": 5,\n      \"minor\": 0,\n      \"patch\": 0\n    },\n    \"lifecycleState\": \"PUBLISHED\",\n    \"url\": \"https://hl7.org/fhir/R5\"\n  },\n  ...\n]\n

    Note

    To learn more, view the API reference or fork our Postman Collection and explore our API.

    "},{"location":"learn/standards/snippets/communication-standard-entity-relationship-diagram/","title":"Communication standard entity relationship diagram","text":"
    erDiagram\n  COMMUNICATION-STANDARD ||--o{ VERSION : contains\n  COMMUNICATION-STANDARD }o..|| ORGANIZATION : references

    Info

    "},{"location":"play/","title":"ZorgAPIs sandbox","text":"

    Explore and experiment with our sandbox API, a secure playground for developers to test functionalities, debug code, and innovate without disrupting live data or environments.

    Info

    When exploring our sandbox API, fork our Postman Collection and select Get New Access Token in the Authorization tab of a request. Postman will automatically populate the relevant parts of the request. To learn more, go to Authenticate with OAuth 2.0 authentication in Postman.

    Register Log out

    Note

    When you fork our Postman Collection, use the environment selector to set Sandbox as the active environment.

    "},{"location":"play/#resources","title":"Resources","text":"

    Here you will find all the tools and assets you need to get started with the ZorgAPIs API.

    "},{"location":"blog/archive/2024/","title":"2024","text":""},{"location":"blog/category/general/","title":"General","text":""}]} \ No newline at end of file