Adding an information standard¶
Entity relationship diagram¶
Info
- Exactly one
INFORMATION-STANDARD
contains zero or moreVERSION
- Zero or more
INFORMATION-STANDARD
references exactly oneORGANIZATION
Add information standard¶
POST https://api.zorgapis.nl/v1beta2/information-standards HTTP/1.1
Content-Type: application/json
{
"name": "MedMij Huisartsgegevens",
"description": "Het verzamelen van huisartsgegevens: je medische dossier bij je huisarts.",
"organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
"url": "https://informatiestandaarden.nictiz.nl/wiki/MedMij:Landingspagina_MedMij"
}
HTTP/1.1 201 Created
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"
}
Note
To learn more, view the API reference or fork our Postman Collection and explore our API.
Add information standard version¶
POST https://api.zorgapis.nl/v1beta2/information-standard-versions HTTP/1.1
Content-Type: application/json
{
"name": "2.0.41",
"description": "Drie aanpassingen in het MedMij Huisartsgegevens kwalificatiemateriaal zodat het overeenkomt met het kwalificatiescript.",
"informationStandardId": "7bc962b1-601d-4759-9a87-68953e7b75e2",
"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"
]
}
HTTP/1.1 201 Created
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.
Set information standard main version¶
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.
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.
Note
To learn more, view the API reference or fork our Postman Collection and explore our API.
Get information standards¶
HTTP/1.1 200 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.
Get information standard versions¶
List all versions for the information standard with id "7bc962b1-601d-4759-9a87-68953e7b75e2"
:
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.