Skip to content

Adding a trust framework

Entity relationship diagram

erDiagram
  TRUST-FRAMEWORK ||--o{ VERSION : contains
  TRUST-FRAMEWORK }o..|| ORGANIZATION : references

Info

  • Exactly one TRUST-FRAMEWORK contains zero or more VERSION
  • Zero or more TRUST-FRAMEWORK references exactly one ORGANIZATION

Add trust framework

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

{
  "name": "MedMij Afsprakenstelsel", // (1)!
  "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.",
  "organizationId": "606becf9-bfd6-4ed1-aadc-7e478af8e456", // (2)!
  "url": "https://afsprakenstelsel.medmij.nl/"
}
  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
Content-Type: application/json

{
  "id": "3d443c34-24a4-4640-bfe5-822627af76e2", // (1)!
  "name": "MedMij Afsprakenstelsel",
  "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.",
  "organizationId": "606becf9-bfd6-4ed1-aadc-7e478af8e456",
  "organization": {
    "id": "606becf9-bfd6-4ed1-aadc-7e478af8e456",
    "name": "Stichting MedMij"
  },
  "url": "https://afsprakenstelsel.medmij.nl/"
}
  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.

Add trust framework version

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

{
  "name": "2.2.2 Verplicht", // (1)!
  "description": "Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.",
  "trustFrameworkId": "3d443c34-24a4-4640-bfe5-822627af76e2", // (2)!
  "publishTime": "2024-09-10T12:00:00.0000000Z", // (3)!
  "semVer": { // (4)!
    "major": 2,
    "minor": 2,
    "patch": 2
  },
  "lifecycleState": "PUBLISHED",
  "url": "https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/"
}
  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
Content-Type: application/json

{
  "id": "2389dc34-2626-4ba3-b4f9-8ad649137d55", // (1)!
  "name": "2.2.2 Verplicht",
  "description": "Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.",
  "trustFrameworkId": "3d443c34-24a4-4640-bfe5-822627af76e2",
  "trustFramework": {
    "id": "3d443c34-24a4-4640-bfe5-822627af76e2",
    "name": "MedMij Afsprakenstelsel"
  },
  "publishTime": "2024-09-10T12:00:00.0000000Z",
  "semVer": {
    "major": 2,
    "minor": 2,
    "patch": 2
  },
  "lifecycleState": "PUBLISHED",
  "url": "https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/"
}
  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.

Set trust framework main version

PATCH https://api.zorgapis.nl/v1beta1/trust-frameworks/3d443c34-24a4-4640-bfe5-822627af76e2 HTTP/1.1
Content-Type: application/json

{
  "mainVersionId": "2389dc34-2626-4ba3-b4f9-8ad649137d55"
}

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

{
  "id": "3d443c34-24a4-4640-bfe5-822627af76e2",
  "name": "MedMij Afsprakenstelsel",
  "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.",
  "organizationId": "606becf9-bfd6-4ed1-aadc-7e478af8e456",
  "organization": {
    "id": "606becf9-bfd6-4ed1-aadc-7e478af8e456",
    "name": "Stichting MedMij"
  },
  "url": "https://afsprakenstelsel.medmij.nl/",
  "mainVersionId": "2389dc34-2626-4ba3-b4f9-8ad649137d55",
  "mainVersion": {
    "id": "2389dc34-2626-4ba3-b4f9-8ad649137d55",
    "name": "2.2.2 Verplicht",
    "description": "Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.",
    "publishTime": "2024-09-10T12:00:00.0000000Z",
    "semVer": {
      "major": 2,
      "minor": 2,
      "patch": 2
    },
    "lifecycleState": "PUBLISHED",
    "url": "https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/"
  }
}

Note

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

Get trust frameworks

GET https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae", // (1)!
    "name": "MedMij Afsprakenstelsel",
    "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.",
    "organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
    "organization": {
      "id": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
      "name": "Stichting MedMij"
    },
    "url": "https://afsprakenstelsel.medmij.nl/",
    "mainVersionId": "78ca8495-a4f4-4b41-b97b-c912c2e96450", // (2)!
    "mainVersion": {
      "id": "78ca8495-a4f4-4b41-b97b-c912c2e96450",
      "name": "2.2.2 Verplicht",
      "description": "Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.",
      "publishTime": "2024-09-10T12:00:00.0000000Z",
      "semVer": {
        "major": 2,
        "minor": 2,
        "patch": 2
      },
      "lifecycleState": "PUBLISHED",
      "url": "https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht"
    }
  },
  ...
]
  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.

Get trust framework versions

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

GET https://api.zorgapis.nl/v1beta1/trust-framework-versions
    ?filter=eq(trustFrameworkId,"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae") HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "78ca8495-a4f4-4b41-b97b-c912c2e96450",
    "name": "2.2.2 Verplicht",
    "description": "Dit is de huidige verplichte versie die door alle deelnemers moet worden ondersteund.",
    "trustFrameworkId": "3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae",
    "trustFramework": {
      "id": "3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae",
      "name": "MedMij Afsprakenstelsel"
    },
    "publishTime": "2024-09-10T12:00:00.0000000Z",
    "semVer": {
      "major": 2,
      "minor": 2,
      "patch": 2
    },
    "lifecycleState": "PUBLISHED",
    "url": "https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht"
  },
  ...
]

Note

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