{
  "resourceType": "StructureDefinition",
  "id": "nl-vzvz-notify-document-ready",
  "language": "nl-NL",
  "url": "http://vzvz.nl/fhir/StructureDefinition/nl-vzvz-notify-document-ready",
  "version": "2.0.0-beta.2",
  "name": "Vzvz_Notify_Document_Ready",
  "title": "Notify Document Ready",
  "status": "draft",
  "publisher": "VZVZ",
  "contact": [
    {
      "name": "VZVZ",
      "telecom": [
        {
          "system": "email",
          "value": "standaardisatie@vzvz.nl",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Request to retrieve a document for further processing",
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "NL",
          "system": "urn:iso:std:iso:3166",
          "display": "Netherlands"
        }
      ]
    }
  ],
  "copyright": "VZVZ",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "CommunicationRequest",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "CommunicationRequest",
        "path": "CommunicationRequest",
        "short": "A request to download the Document",
        "definition": "A request to download the document described in the DocumentReference which is referenced in the reasonReference element.",
        "comment": "Note that the requester is implemented as a reference to a contained Device."
      },
      {
        "id": "CommunicationRequest.identifier",
        "path": "CommunicationRequest.identifier",
        "comment": "It is advised to use an OID as identifier to allow a mix and match between request notifications and retrieval notifications in V3 and FHIR. This will improve the ease of migration.",
        "min": 1,
        "example": [
          {
            "label": "OID",
            "valueIdentifier": {
              "value": "urn:oid:2.16.840.1.113883.2.4.3.111.5.2.1.12345"
            }
          }
        ]
      },
      {
        "id": "CommunicationRequest.groupIdentifier",
        "path": "CommunicationRequest.groupIdentifier",
        "short": "Identifier to match both exchanges in a synchronization workflow",
        "definition": "The groupIdentifier is used to connect both exchanges of the synchronization workflow. Use the same groupIdentifier in all exchanges that refer to the same synchronization.\n\nThe groupIdentifier is defined by the client initiating the first request. \nIn all subsequent exchanges pertaining to this synchronization this same groupIdentifier is used in the Notifiy Document Ready requests.\n\nThe client and server participating in this synchronization should persist this identifier as long as the synchronization is not finalized.",
        "min": 1,
        "example": [
          {
            "label": "groupIdentifier",
            "valueIdentifier": {
              "system": "http://initiatingsystem.nl/myIdentifierSystem",
              "value": "1.2.3.4.5.6.7"
            }
          }
        ]
      },
      {
        "id": "CommunicationRequest.status",
        "path": "CommunicationRequest.status",
        "fixedCode": "active"
      },
      {
        "id": "CommunicationRequest.category",
        "path": "CommunicationRequest.category",
        "short": "Context of document exchange",
        "definition": "The category is used to indicate in which context this document exchange takes place",
        "min": 1,
        "example": [
          {
            "label": "RegisterSync",
            "valueCodeableConcept": {
              "coding": [
                {
                  "code": "RegisterSync",
                  "system": "http://vzvz.nl/fhir/CodeSystem/doc-exchange-category"
                }
              ]
            }
          }
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "http://vzvz.nl/fhir/ValueSet/doc-exchange-category"
        }
      },
      {
        "id": "CommunicationRequest.occurrence[x]",
        "path": "CommunicationRequest.occurrence[x]",
        "short": "Validity period",
        "definition": "The period during which the document can be retrieved",
        "comment": "The start time is the creation date of the document. The end time is the time when the document is no longer available.",
        "min": 1,
        "type": [
          {
            "code": "Period"
          }
        ],
        "example": [
          {
            "label": "Example validity period",
            "valuePeriod": {
              "start": "2024-05-28T00:00:00+00:00",
              "end": "2024-05-28T01:00:00+00:00"
            }
          }
        ]
      },
      {
        "id": "CommunicationRequest.occurrence[x].start",
        "path": "CommunicationRequest.occurrence[x].start",
        "min": 1
      },
      {
        "id": "CommunicationRequest.occurrence[x].end",
        "path": "CommunicationRequest.occurrence[x].end",
        "min": 1
      },
      {
        "id": "CommunicationRequest.authoredOn",
        "path": "CommunicationRequest.authoredOn",
        "short": "Creation time of the request",
        "min": 1,
        "example": [
          {
            "label": "RequestCreation",
            "valueDateTime": "2024-05-27T23:59:55+00:00"
          }
        ]
      },
      {
        "id": "CommunicationRequest.requester",
        "path": "CommunicationRequest.requester",
        "comment": "Note that the requester is implemented as a reference to a contained Device.",
        "min": 1
      },
      {
        "id": "CommunicationRequest.reasonCode",
        "path": "CommunicationRequest.reasonCode",
        "min": 1,
        "example": [
          {
            "label": "VWI-sync",
            "valueCodeableConcept": {
              "coding": [
                {
                  "code": "vwi_sync",
                  "system": "http://vzvz.nl/fhir/CodeSystem/aorta-sync"
                }
              ]
            }
          }
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "http://vzvz.nl/fhir/ValueSet/aorta-sync",
          "description": "Code for describing reason for this request"
        }
      },
      {
        "id": "CommunicationRequest.reasonReference",
        "path": "CommunicationRequest.reasonReference",
        "short": "Information on the document",
        "definition": "Indicates a DocumentReference that provides the metadata of the document to be retrieved",
        "comment": "Reference the contained DocumentReference",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
              "http://hl7.org/fhir/StructureDefinition/DocumentReference"
            ]
          }
        ]
      }
    ]
  }
}