Adding an information standard

Entity relationship diagram

erDiagram
  INFORMATION-STANDARD ||--o{ VERSION : contains
  INFORMATION-STANDARD }o..|| ORGANIZATION : references

Info

• Exactly one INFORMATION-STANDARD contains zero or more VERSION
• Zero or more INFORMATION-STANDARD references exactly one ORGANIZATION

Add information standard

RequestResponse

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

{
  "name": "MedMij Huisartsgegevens", // (1)!
  "description": "Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.",
  "organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad", // (2)!
  "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:Landingspagina_MedMij"
}

1. The name of the information standard, must be unique for this organization (see "organizationId").
2. The UUID of the organization that maintains the information standard.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "7bc962b1-601d-4759-9a87-68953e7b75e2", // (1)!
  "name": "MedMij 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"
  },
  "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:Landingspagina_MedMij"
}

1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the information standard by the API server.

Note

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

Add information standard version

RequestResponse

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

{
  "name": "2.0.41", // (1)!
  "description": "Drie aanpassingen in het MedMij Huisartsgegevens kwalificatiemateriaal zodat het overeenkomt met het kwalificatiescript.",
  "informationStandardId": "7bc962b1-601d-4759-9a87-68953e7b75e2", // (2)!
  "publishTime": "2024-11-20T12:00:00.0000000Z", // (3)!
  "semVer": { // (4)!
    "major": 2,
    "minor": 0,
    "patch": 41
  },
  "lifecycleState": "PUBLISHED",
  "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens",
  "careTypes": [
    "GENERAL_PRACTITIONERS"
  ]
}

1. The name of the information standard version, must be unique for this information standard (see "informationStandardId").
2. The UUID of the information standard to which this version belongs.

3. The date and time (formatted as per ISO 8601) at which the information 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 information 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
Content-Type: application/json

{
  "id": "20685da1-0e1d-40b9-a0f6-5a89c444f48c", // (1)!
  "name": "2.0.41",
  "description": "Drie aanpassingen in het MedMij Huisartsgegevens kwalificatiemateriaal zodat het overeenkomt met het kwalificatiescript.",
  "informationStandardId": "7bc962b1-601d-4759-9a87-68953e7b75e2",
  "informationStandard": {
    "id": "7bc962b1-601d-4759-9a87-68953e7b75e2",
    "name": "MedMij Huisartsgegevens"
  },
  "publishTime": "2024-11-20T12:00:00.0000000Z",
  "semVer": {
    "major": 2,
    "minor": 0,
    "patch": 41
  },
  "lifecycleState": "PUBLISHED",
  "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens",
  "careTypes": [
    "GENERAL_PRACTITIONERS"
  ]
}

1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the information standard version by the API server.

Note

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

Set information standard main version

RequestResponse

PATCH https://api.zorgapis.nl/v1beta1/information-standards/7bc962b1-601d-4759-9a87-68953e7b75e2 HTTP/1.1
Content-Type: application/json

{
  "mainVersionId": "20685da1-0e1d-40b9-a0f6-5a89c444f48c"
}

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

{
  "id": "7bc962b1-601d-4759-9a87-68953e7b75e2",
  "name": "MedMij 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"
  },
  "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:Landingspagina_MedMij",
  "mainVersionId": "20685da1-0e1d-40b9-a0f6-5a89c444f48c",
  "mainVersion": {
    "id": "20685da1-0e1d-40b9-a0f6-5a89c444f48c",
    "name": "2.0.41",
    "description": "Drie aanpassingen in het MedMij Huisartsgegevens kwalificatiemateriaal zodat het overeenkomt met het kwalificatiescript.",
    "publishTime": "2024-11-20T12:00:00.0000000Z",
    "semVer": {
      "major": 2,
      "minor": 0,
      "patch": 41
    },
    "lifecycleState": "PUBLISHED",
    "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens",
    "careTypes": [
      "GENERAL_PRACTITIONERS"
    ]
  }
}

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 information standard version. To find the appropriate version, visit this section for a guide on listing all available versions of a communication standard.

RequestResponse

PUT https://api.zorgapis.nl/v1beta1/information-standard-versions/20685da1-0e1d-40b9-a0f6-5a89c444f48c/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 information standard version. To find the appropriate version, visit this section for a guide on listing all available versions of a trust framework.

RequestResponse

PUT https://api.zorgapis.nl/v1beta1/information-standard-versions/20685da1-0e1d-40b9-a0f6-5a89c444f48c/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.

Get information standards

RequestResponse

GET https://api.zorgapis.nl/v1beta1/information-standards HTTP/1.1

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

[
  {
    "id": "7bc962b1-601d-4759-9a87-68953e7b75e2", // (1)!
    "name": "MedMij 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"
    },
    "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:Landingspagina_MedMij",
    "mainVersionId": "20685da1-0e1d-40b9-a0f6-5a89c444f48c", // (2)!
    "mainVersion": {
      "id": "20685da1-0e1d-40b9-a0f6-5a89c444f48c",
      "name": "2.0.41",
      "description": "Drie aanpassingen in het MedMij Huisartsgegevens kwalificatiemateriaal zodat het overeenkomt met het kwalificatiescript.",
      "publishTime": "2024-11-20T12:00:00.0000000Z",
      "semVer": {
        "major": 2,
        "minor": 0,
        "patch": 41
      },
      "lifecycleState": "PUBLISHED",
      "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens",
      "careTypes": [
        "GENERAL_PRACTITIONERS"
      ]
    }
  },
  ...
]

1. The UUID of the information 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.

Get information standard versions

List all versions for the information standard with id "7bc962b1-601d-4759-9a87-68953e7b75e2":

RequestResponse

GET https://api.zorgapis.nl/v1beta1/information-standard-versions
    ?filter=eq(informationStandardId,"7bc962b1-601d-4759-9a87-68953e7b75e2") HTTP/1.1

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

[
  {
    "id": "20685da1-0e1d-40b9-a0f6-5a89c444f48c",
    "name": "2.0.41",
    "description": "Drie aanpassingen in het MedMij Huisartsgegevens kwalificatiemateriaal zodat het overeenkomt met het kwalificatiescript.",
    "informationStandardId": "7bc962b1-601d-4759-9a87-68953e7b75e2",
    "informationStandard": {
      "id": "7bc962b1-601d-4759-9a87-68953e7b75e2",
      "name": "MedMij Huisartsgegevens"
    },
    "publishTime": "2024-11-20T12:00:00.0000000Z",
    "semVer": {
      "major": 2,
      "minor": 0,
      "patch": 41
    },
    "lifecycleState": "PUBLISHED",
    "url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/OntwerpHuisartsgegevens",
    "careTypes": [
      "GENERAL_PRACTITIONERS"
    ]
  },
  ...
]

Note

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