Skip to content

Commit bedeb6f

Browse files
jnlycklamaanandanthony
jnlycklama
authored and
anandanthony
committed
EventGrid - AzureHealthcareApis swagger update for GA (Azure#20918)
* add new dicom event types * Remove dicom prefix * serviceSequence -> sequenceNumber * fix prettier errors * Add example files to main swagger
1 parent 464e1db commit bedeb6f

File tree

8 files changed

+135
-4
lines changed

8 files changed

+135
-4
lines changed

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,76 @@
8888
}
8989
}
9090
},
91+
"HealthcareDicomImageCreatedEventData": {
92+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.",
93+
"type": "object",
94+
"properties": {
95+
"imageStudyInstanceUid": {
96+
"description": "Unique identifier for the Study",
97+
"type": "string"
98+
},
99+
"imageSeriesInstanceUid": {
100+
"description": "Unique identifier for the Series",
101+
"type": "string"
102+
},
103+
"imageSopInstanceUid": {
104+
"description": "Unique identifier for the DICOM Image",
105+
"type": "string"
106+
},
107+
"serviceHostName": {
108+
"description": "Domain name of the DICOM account for this image.",
109+
"type": "string"
110+
},
111+
"sequenceNumber": {
112+
"description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service.",
113+
"type": "integer",
114+
"format": "int64"
115+
}
116+
},
117+
"x-ms-examples": {
118+
"DicomImageCreatedCloudEventsSchema": {
119+
"$ref": "./examples/cloud-events-schema/dicom_image_created.json"
120+
},
121+
"DicomImageCreatedEventGridSchema": {
122+
"$ref": "./examples/event-grid-schema/dicom_image_created.json"
123+
}
124+
}
125+
},
126+
"HealthcareDicomImageDeletedEventData": {
127+
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.",
128+
"type": "object",
129+
"properties": {
130+
"imageStudyInstanceUid": {
131+
"description": "Unique identifier for the Study",
132+
"type": "string"
133+
},
134+
"imageSeriesInstanceUid": {
135+
"description": "Unique identifier for the Series",
136+
"type": "string"
137+
},
138+
"imageSopInstanceUid": {
139+
"description": "Unique identifier for the DICOM Image",
140+
"type": "string"
141+
},
142+
"serviceHostName": {
143+
"description": "Host name of the DICOM account for this image.",
144+
"type": "string"
145+
},
146+
"sequenceNumber": {
147+
"description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service.",
148+
"type": "integer",
149+
"format": "int64"
150+
}
151+
},
152+
"x-ms-examples": {
153+
"DicomImageDeletedCloudEventsSchema": {
154+
"$ref": "./examples/cloud-events-schema/dicom_image_deleted.json"
155+
},
156+
"DicomImageDeletedEventGridSchema": {
157+
"$ref": "./examples/event-grid-schema/dicom_image_deleted.json"
158+
}
159+
}
160+
},
91161
"HealthcareFhirResourceType": {
92162
"description": "Schema of FHIR resource type enumeration.",
93163
"type": "string",
@@ -907,4 +977,3 @@
907977
}
908978
}
909979
}
910-

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_created.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
3+
"subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
4+
"type": "Microsoft.HealthcareApis.DicomImageCreated",
5+
"time": "2022-09-15T01:14:04.5613214Z",
6+
"id": "d621839d-958b-4142-a638-bb966b4f7dfd",
7+
"data": {
8+
"imageStudyInstanceUid": "1.2.3.4.3",
9+
"imageSeriesInstanceUid": "1.2.3.4.3.9423673",
10+
"imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
11+
"serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
12+
"sequenceNumber": 1
13+
},
14+
"specVersion": "1.0"
15+
}

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_deleted.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
3+
"subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
4+
"type": "Microsoft.HealthcareApis.DicomImageDeleted",
5+
"time": "2022-09-15T01:14:04.5613214Z",
6+
"id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021",
7+
"data": {
8+
"imageStudyInstanceUid": "1.2.3.4.3",
9+
"imageSeriesInstanceUid": "1.2.3.4.3.9423673",
10+
"imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
11+
"serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
12+
"sequenceNumber": 2
13+
},
14+
"specVersion": "1.0"
15+
}

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/fhir_resource_created.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
"resourceVersionId": 1
1212
},
1313
"specVersion": "1.0"
14-
}
14+
}

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/fhir_resource_deleted.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
"resourceVersionId": 3
1212
},
1313
"specVersion": "1.0"
14-
}
14+
}

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/fhir_resource_updated.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
"resourceVersionId": 2
1212
},
1313
"specVersion": "1.0"
14-
}
14+
}

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_created.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"id": "d621839d-958b-4142-a638-bb966b4f7dfd",
3+
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
4+
"subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
5+
"data": {
6+
"imageStudyInstanceUid": "1.2.3.4.3",
7+
"imageSeriesInstanceUid": "1.2.3.4.3.9423673",
8+
"imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
9+
"serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
10+
"sequenceNumber": 1
11+
},
12+
"eventType": "Microsoft.HealthcareApis.DicomImageCreated",
13+
"dataVersion": "1",
14+
"metadataVersion": "1",
15+
"eventTime": "2022-09-15T01:14:04.5613214Z"
16+
}

‎specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_deleted.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021",
3+
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
4+
"subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
5+
"data": {
6+
"imageStudyInstanceUid": "1.2.3.4.3",
7+
"imageSeriesInstanceUid": "1.2.3.4.3.9423673",
8+
"imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
9+
"serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
10+
"sequenceNumber": 2
11+
},
12+
"eventType": "Microsoft.HealthcareApis.DicomImageDeleted",
13+
"dataVersion": "1",
14+
"metadataVersion": "1",
15+
"eventTime": "2022-09-15T01:16:07.5692209Z"
16+
}

0 commit comments

Comments
 (0)