Skip to content

Adding a communication standard

Entity relationship diagram

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

Info

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

Add communication standard

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

{
  "name": "FHIR", // (1)!
  "description": "FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.",
  "organizationId": "a70590c6-06ce-4dba-9098-ed996335bdec", // (2)!
  "url": "https://hl7.org/fhir/"
}
  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
Content-Type: application/json

{
  "id": "05d8de10-1932-4e7f-badf-655c1a82fcc3", // (1)!
  "name": "FHIR",
  "description": "FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.",
  "organizationId": "a70590c6-06ce-4dba-9098-ed996335bdec",
  "organization": {
    "id": "a70590c6-06ce-4dba-9098-ed996335bdec",
    "name": "HL7 Nederland"
  },
  "url": "https://hl7.org/fhir/"
}
  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.

Add communication standard version

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

{
  "name": "R5", // (1)!
  "description": "FHIR Specification 5.0.0",
  "communicationStandardId": "05d8de10-1932-4e7f-badf-655c1a82fcc3", // (2)!
  "publishTime": "2023-03-26T12:00:00.0000000Z", // (3)!
  "semVer": { // (4)!
    "major": 5,
    "minor": 0,
    "patch": 0
  },
  "lifecycleState": "PUBLISHED",
  "url": "https://hl7.org/fhir/R5"
}
  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
Content-Type: application/json

{
  "id": "8ae84d7f-73e7-4f08-b839-c73c97128ada", // (1)!
  "name": "R5",
  "description": "FHIR Specification 5.0.0",
  "communicationStandardId": "05d8de10-1932-4e7f-badf-655c1a82fcc3",
  "communicationStandard": {
    "id": "05d8de10-1932-4e7f-badf-655c1a82fcc3",
    "name": "FHIR"
  },
  "publishTime": "2023-03-26T12:00:00.0000000Z",
  "semVer": {
    "major": 5,
    "minor": 0,
    "patch": 0
  },
  "lifecycleState": "PUBLISHED",
  "url": "https://hl7.org/fhir/R5"
}
  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.

Set communication standard main version

PATCH https://api.zorgapis.nl/v1beta1/communication-standards/05d8de10-1932-4e7f-badf-655c1a82fcc3 HTTP/1.1
Content-Type: application/json

{
  "mainVersionId": "8ae84d7f-73e7-4f08-b839-c73c97128ada"
}

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

{
  "id": "05d8de10-1932-4e7f-badf-655c1a82fcc3",
  "name": "FHIR",
  "description": "FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.",
  "organizationId": "a70590c6-06ce-4dba-9098-ed996335bdec",
  "organization": {
    "id": "a70590c6-06ce-4dba-9098-ed996335bdec",
    "name": "HL7 Nederland"
  },
  "url": "https://hl7.org/fhir/",
  "mainVersionId": "8ae84d7f-73e7-4f08-b839-c73c97128ada",
  "mainVersion": {
    "id": "8ae84d7f-73e7-4f08-b839-c73c97128ada",
    "name": "R5",
    "description": "FHIR Specification 5.0.0",
    "publishTime": "2023-03-26T12:00:00.0000000Z",
    "semVer": {
      "major": 5,
      "minor": 0,
      "patch": 0
    },
    "lifecycleState": "PUBLISHED",
    "url": "https://hl7.org/fhir/R5"
  }
}

Note

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

Get communication standards

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

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

[
  {
    "id": "05d8de10-1932-4e7f-badf-655c1a82fcc3", // (1)!
    "name": "FHIR",
    "description": "FHIR (Fast Health Interoperability Resources) is an HL7 specification for Healthcare Interoperability.",
    "organizationId": "a70590c6-06ce-4dba-9098-ed996335bdec",
    "organization": {
      "id": "a70590c6-06ce-4dba-9098-ed996335bdec",
      "name": "HL7 Nederland"
    },
    "url": "https://hl7.org/fhir/",
    "mainVersionId": "8ae84d7f-73e7-4f08-b839-c73c97128ada", // (2)!
    "mainVersion": {
      "id": "8ae84d7f-73e7-4f08-b839-c73c97128ada",
      "name": "R5",
      "description": "FHIR Specification 5.0.0",
      "publishTime": "2023-03-26T12:00:00.0000000Z",
      "semVer": {
        "major": 5,
        "minor": 0,
        "patch": 0
      },
      "lifecycleState": "PUBLISHED",
      "url": "https://hl7.org/fhir/R5"
    }
  },
  ...
]
  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.

Get communication standard versions

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

GET https://api.zorgapis.nl/v1beta1/communication-standard-versions
    ?filter=eq(communicationStandardId,"05d8de10-1932-4e7f-badf-655c1a82fcc3") HTTP/1.1

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

[
  {
    "id": "8ae84d7f-73e7-4f08-b839-c73c97128ada",
    "name": "R5",
    "description": "FHIR Specification 5.0.0",
    "communicationStandardId": "05d8de10-1932-4e7f-badf-655c1a82fcc3",
    "communicationStandard": {
      "id": "05d8de10-1932-4e7f-badf-655c1a82fcc3",
      "name": "FHIR"
    },
    "publishTime": "2023-03-26T12:00:00.0000000Z",
    "semVer": {
      "major": 5,
      "minor": 0,
      "patch": 0
    },
    "lifecycleState": "PUBLISHED",
    "url": "https://hl7.org/fhir/R5"
  },
  ...
]

Note

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