Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EventGrid - AzureHealthcareApis swagger update for GA #20918

Merged
merged 5 commits into from
Nov 4, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,60 @@
}
}
},
"HealthcareDicomImageCreatedEventData": {
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.",
"type": "object",
"properties": {
"dicomImageStudyInstanceUid": {
"description": "Unique identifier for the Study",
"type": "string"
},
"dicomImageSeriesInstanceUid": {
"description": "Unique identifier for the Series",
"type": "string"
},
"dicomImageSopInstanceUid": {
"description": "Unique identifier for the DICOM Image",
"type": "string"
},
"dicomServiceHostName": {
"description": "Domain name of the DICOM account for this image.",
"type": "string"
},
"dicomServiceSequence": {
"description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service.",
"type": "integer",
"format": "int64"
}
}
},
"HealthcareDicomImageDeletedEventData": {
"description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.",
"type": "object",
"properties": {
"dicomImageStudyInstanceUid": {
JoshLove-msft marked this conversation as resolved.
Show resolved Hide resolved
"description": "Unique identifier for the Study",
"type": "string"
},
"dicomImageSeriesInstanceUid": {
"description": "Unique identifier for the Series",
"type": "string"
},
"dicomImageSopInstanceUid": {
"description": "Unique identifier for the DICOM Image",
"type": "string"
},
"dicomServiceHostName": {
"description": "Host name of the DICOM account for this image.",
"type": "string"
},
"dicomServiceSequence": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the sequence purely a service concept? i.e. is not called out in the DICOM spec? Is this different than the Sequence defined here - https://dicom.nema.org/medical/Dicom/2016c/output/chtml/part03/sect_5.2.html

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I called this sequence based on your comment in the private PR. It was previously called changefeedId.

Its not the same sequence from that link. Its essentially the sequence number for changes occurred in the dicom service. Each dicom service keeps a change log. When any image is added or deleted from the service, that change gets added to the change log with a new sequence number. This change log is exposed through our Change Feed API https://github.com/microsoft/dicom-server/blob/main/docs/concepts/change-feed.md , which is specific to our service and not part of the DICOM standard.

I like the change to sequence because it is more generic, however I don't want to get it confused with this kind of Sequence https://dicom.nema.org/medical/Dicom/2016c/output/chtml/part03/sect_5.2.html . What do you think?

Copy link
Member

@JoshLove-msft JoshLove-msft Sep 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think SequenceNumber is a bit less ambiguous even aside from the Dicom naming conflict. Is the Change Feed API already GA?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah the Changefeed API is GA in our service, it was included in the initial GA release of the DICOM service in March.

I will go ahead and change to property to sequenceNumber

"description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service.",
"type": "integer",
"format": "int64"
}
}
},
"HealthcareFhirResourceType": {
"description": "Schema of FHIR resource type enumeration.",
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"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",
"type": "Microsoft.HealthcareApis.DicomImageCreated",
"time": "2022-09-15T01:14:04.5613214Z",
"id": "d621839d-958b-4142-a638-bb966b4f7dfd",
"data": {
"dicomImageStudyInstanceUid": "1.2.3.4.3",
"dicomImageSeriesInstanceUid": "1.2.3.4.3.9423673",
"dicomImageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"dicomServiceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
"dicomServiceSequence": 1
},
"specVersion": "1.0"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"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",
"type": "Microsoft.HealthcareApis.DicomImageDeleted",
"time": "2022-09-15T01:14:04.5613214Z",
"id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021",
"data": {
"dicomImageStudyInstanceUid": "1.2.3.4.3",
"dicomImageSeriesInstanceUid": "1.2.3.4.3.9423673",
"dicomImageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"dicomServiceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
"dicomServiceSequence": 2
},
"specVersion": "1.0"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "d621839d-958b-4142-a638-bb966b4f7dfd",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"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",
"data": {
"dicomImageStudyInstanceUid": "1.2.3.4.3",
"dicomImageSeriesInstanceUid": "1.2.3.4.3.9423673",
"dicomImageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"dicomServiceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
"dicomServiceSequence": 1
},
"eventType": "Microsoft.HealthcareApis.DicomImageCreated",
"dataVersion": "1",
"metadataVersion": "1",
"eventTime": "2022-09-15T01:14:04.5613214Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"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",
"data": {
"dicomImageStudyInstanceUid": "1.2.3.4.3",
"dicomImageSeriesInstanceUid": "1.2.3.4.3.9423673",
"dicomImageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"dicomServiceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
"dicomServiceSequence": 2
},
"eventType": "Microsoft.HealthcareApis.DicomImageDeleted",
"dataVersion": "1",
"metadataVersion": "1",
"eventTime": "2022-09-15T01:16:07.5692209Z"
}