Skip to content

Adding an API specification

Entity relationship diagram

erDiagram
  API-SPECIFICATION ||--o{ VERSION : contains
  VERSION ||--o{ DECLARATION-OF-CONFORMITY : contains
  API-SPECIFICATION }o..|| ORGANIZATION : references

Info

  • Exactly one API-SPECIFICATION contains zero or more VERSION
  • Exactly one VERSION contains zero or more DECLARATION-OF-CONFORMITY
  • Zero or more API-SPECIFICATION references exactly one ORGANIZATION

Add API specification

POST https://api.zorgapis.nl/v1beta1/api-specifications HTTP/1.1
Content-Type: application/json

{
  "name": "Verzamelen Huisartsgegevens", // (1)!
  "description": "Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.",
  "organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad", // (2)!
  "architecturalStyle": "REST" // (3)!
}
  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
Content-Type: application/json

{
  "id": "fe30bf05-de07-4556-9b17-1f82d62fe45f", // (1)!
  "name": "Verzamelen Huisartsgegevens",
  "description": "Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.",
  "organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
  "organization": {
    "id": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
    "name": "Nictiz"
  },
  "architecturalStyle": "REST"
}
  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.

Add API specification version

POST https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions HTTP/1.1
Content-Type: application/json

{
  "name": "2.0", // (1)!
  "description": "Verzamelen Huisartsgegevens 2.0",
  "publishTime": "2020-09-02T00:00:00.000Z", // (2)!
  "semVer": { // (3)!
    "major": 2,
    "minor": 0,
    "patch": 0
  },
  "lifecycleState": "PUBLISHED",
  "urls": [
    {
      "type": "FUNCTIONAL_DESIGN", // (4)!
      "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens"
    },
    {
      "type": "TECHNICAL_DESIGN",
      "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data"
    }
  ]
}
  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
Content-Type: application/json

{
  "id": "15261fd0-b292-45d9-b6b1-266cc922fb50", // (1)!
  "name": "2.0",
  "description": "Verzamelen Huisartsgegevens 2.0",
  "publishTime": "2020-09-02T00:00:00.000Z",
  "semVer": {
    "major": 2,
    "minor": 0,
    "patch": 0
  },
  "lifecycleState": "PUBLISHED",
  "urls": [
    {
      "id": "37bfbf71-570c-45c1-9fbf-7e5f63db61b8", // (2)!
      "type": "FUNCTIONAL_DESIGN",
      "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens"
    },
    {
      "id": "8a87c023-aabb-454f-8e1a-3443a13f11e2",
      "type": "TECHNICAL_DESIGN",
      "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data"
    }
  ]
}
  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.

Add declaration of conformity

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.

The importance of transparency

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.

Declarations are immutable

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.

Providing evidence

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.

Architectural styles

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 
{
  "requirementsVersion": "1.2.0", // (1)!
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT",
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT",
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE",
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    "SD001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.015": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.016": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.017": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR-R001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR-R002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC-R001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC-R002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC-R003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003": {
      "conformityType": "NOT_CONFORMANT"
    }
  }
}
  1. The name of the API requirements version, for example "1.2.0", against which to validate this version of the API specification.
{
  "requirementsVersion": "1.2.0",
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT",
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT",
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE",
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    "SD001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.015": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.016": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.017": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR-S001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC-S001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC-S002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003": {
      "conformityType": "NOT_CONFORMANT"
    }
  }
}

{
  "requirementsVersion": "1.2.0",
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT",
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT",
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE",
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    "SD001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.015": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.016": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.017": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003": {
      "conformityType": "NOT_CONFORMANT"
    }
  }
}

{
  "requirementsVersion": "1.2.0",
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT",
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT",
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE",
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    "SD001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.015": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.016": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.017": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003": {
      "conformityType": "NOT_CONFORMANT"
    }
  }
}

{
  "requirementsVersion": "1.2.0",
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT",
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT",
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE",
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    "SD001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.015": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.016": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.017": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003": {
      "conformityType": "NOT_CONFORMANT"
    }
  }
}

{
  "requirementsVersion": "1.2.0",
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT",
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT",
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE",
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    "SD001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.015": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.016": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD001.017": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD004.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD005.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD009.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD010": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD011": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD013": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SD014": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DI001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM001.004": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM002.003": {
      "conformityType": "NOT_CONFORMANT"
    },
    "LM008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "DR012": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC006": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC007": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC008": {
      "conformityType": "NOT_CONFORMANT"
    },
    "SC009": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.001": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003.002": {
      "conformityType": "NOT_CONFORMANT"
    },
    "IS003": {
      "conformityType": "NOT_CONFORMANT"
    }
  }
}

Example

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
Content-Type: application/json

{
  "requirementsVersion": "1.2.0", // (1)!
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT", // (2)!
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT", // (3)!
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE", // (4)!
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    ...
  }
}
  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
Content-Type: application/json

{
  "id": "188c9c2c-ea9e-48fa-8423-5e8e2f60161c",
  "requirementsVersion": "1.2.0",
  "rankingLevel": "OPEN_API",
  "rankings": {
    "OPEN_API": {
      "score": 27,
      "maximumScore": 31
    },
    "TECHNICALLY_STANDARDIZED_API": {
      "score": 6,
      "maximumScore": 11
    },
    "FULLY_STANDARDIZED_API": {
      "score": 2,
      "maximumScore": 6
    }
  },
  "requirements": {
    "SD001": {
      "conformityType": "CONFORMANT",
      "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."
    },
    "SD001.001": {
      "conformityType": "NOT_CONFORMANT",
      "remarks": "For example, explain why the resource does not meet this requirement."
    },
    "SD001.002": {
      "conformityType": "NOT_APPLICABLE",
      "remarks": "For example, explain why this requirement does not apply to the resource."
    },
    ...
  }
}

Note

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

Set API specification main version

PATCH https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f HTTP/1.1
Content-Type: application/json

{
  "mainVersionId": "15261fd0-b292-45d9-b6b1-266cc922fb50"
}

HTTP/1.1 20O OK
Content-Type: application/json

{
  "id": "fe30bf05-de07-4556-9b17-1f82d62fe45f",
  "name": "Verzamelen Huisartsgegevens",
  "description": "Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.",
  "organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
  "organization": {
    "id": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
    "name": "Nictiz"
  },
  "architecturalStyle": "REST",
  "mainVersionId": "15261fd0-b292-45d9-b6b1-266cc922fb50",
  "mainVersion": {
    "id": "15261fd0-b292-45d9-b6b1-266cc922fb50",
    "name": "2.0",
    "description": "Verzamelen Huisartsgegevens 2.0",
    "publishTime": "2020-09-02T00:00:00.000Z",
    "semVer": {
      "major": 2,
      "minor": 0,
      "patch": 0
    },
    "lifecycleState": "PUBLISHED",
    "urls": [
      {
        "id": "37bfbf71-570c-45c1-9fbf-7e5f63db61b8",
        "type": "FUNCTIONAL_DESIGN",
        "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens"
      },
      {
        "id": "8a87c023-aabb-454f-8e1a-3443a13f11e2",
        "type": "TECHNICAL_DESIGN",
        "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_GP_Data"
      }
    ],
    "lastDeclarationOfConformity": {
      "id": "188c9c2c-ea9e-48fa-8423-5e8e2f60161c",
      "requirementsVersion": "1.2.0",
      "rankingLevel": "OPEN_API",
      "rankings": {
        "OPEN_API": {
          "score": 27,
          "maximumScore": 31
        },
        "TECHNICALLY_STANDARDIZED_API": {
          "score": 6,
          "maximumScore": 11
        },
        "FULLY_STANDARDIZED_API": {
          "score": 2,
          "maximumScore": 6
        }
      }
    }
  }
}

Note

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

Add communication standard version

Learn how to link a communication standard version to your API specification version. To find the appropriate version, visit this section for a guide on listing all available versions of a communication standard.

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.

Note

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

Add trust framework version

Learn how to link a trust framework version to your API specification version. To find the appropriate version, visit this section for a guide on listing all available versions of a trust framework.

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.

Note

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