Érvényesítési művelet : Áttekintés
Fontos
Az Azure API for FHIR 2026. szeptember 30-án megszűnik. A migrálási stratégiákat követve válthat az Azure Health Data Services FHIR szolgáltatásra ezen a napon. Az Azure API for FHIR megszűnése miatt 2025. április 1-től nem lesz lehetőség új üzembe helyezéseket végezni. Az Azure Health Data Services FHIR szolgáltatás az Azure API for FHIR továbbfejlesztett verziója, amely lehetővé teszi az ügyfelek számára az FHIR, a DICOM és a MedTech szolgáltatások kezelését más Azure-szolgáltatásokba való integrációval.
Az Azure API for FHIR-ben található áruházi profilok cikkben végigvezette az FHIR-profilok alapjait, és tárolhatja őket. Ez a cikk bemutatja, hogyan használható $validate
az erőforrások profilokhoz való ellenőrzéséhez. Az erőforrás profilhoz való érvényesítése azt jelenti, hogy ellenőrzi, hogy az erőforrás megfelel-e a profilnak, beleértve a megvalósítási útmutatóban Resource.meta.profile
vagy a megvalósítási útmutatóban felsorolt specifikációkat is.
$validate
A Fast Healthcare Együttműködési erőforrások (FHIR®) egy olyan művelete, amely lehetővé teszi, hogy egy FHIR-erőforrás megfeleljen az alaperőforrás-követelményeknek vagy egy megadott profilnak. Ez a művelet biztosítja, hogy az FHIR-hez készült Azure API adatai a várt attribútumokkal és értékekkel rendelkezjenek. Az érvényesítési művelettel kapcsolatos információkért tekintse meg a HL7 FHIR specifikációját. Specifikációnként a mód megadható például a létrehozással és a frissítéssel $validate
:
create
: Az Azure API for FHIR ellenőrzi, hogy a profil tartalma egyedi-e a meglévő erőforrásoktól, és hogy elfogadható-e új erőforrásként létrehozni.update
: Ellenőrzi, hogy a profil frissítés-e a kijelölt meglévő erőforráson (azaz a nem módosítható mezőkön nem történt módosítás).
Az erőforrás ellenőrzésének különböző módjai vannak:
- Meglévő erőforrás érvényesítése érvényesítési művelettel.
- Új erőforrás érvényesítése érvényesítési művelettel.
- Az erőforrás LÉTREHOZÁS/FRISSÍTÉS ellenőrzése fejléc használatával.
Az Azure API for FHIR mindig a $validate művelet érvényesítési eredményeit adja vissza OperationOutcome
. Az Azure API for FHIR szolgáltatás két lépéses ellenőrzést végez, miután egy erőforrást átadtak $validate végpontnak – az első lépés egy alapszintű ellenőrzés, amely biztosítja, hogy az erőforrás elemezhető legyen. Az erőforrás-elemzés során az egyes hibákat ki kell javítani, mielőtt továbblépnénk a következő lépésre. Az erőforrás sikeres elemzése után a rendszer a teljes ellenőrzést második lépésként hajtja végre.
Feljegyzés
Az ellenőrzéshez használni kívánt értékkészleteket fel kell tölteni az FHIR-kiszolgálóra. Ide tartoznak az FHIR-specifikáció részét képező értékhalmazok, valamint a megvalósítási útmutatókban meghatározott értékhalmazok. Csak az összes kód teljes listáját tartalmazó teljesen kibontott értékhalmazok támogatottak. A külső forrásokra hivatkozó ValueSet-definíciók nem támogatottak.
Meglévő erőforrás érvényesítése
Meglévő erőforrás érvényesítéséhez használja $validate
a következőt egy GET
kérelemben:
GET http://<your Azure API for FHIR base URL>/{resource}/{resource ID}/$validate
Példa:
GET https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Patient/a6e11662-def8-4dde-9ebc-4429e68d130e/$validate
Ebben a példában a meglévő Beteg erőforrást a6e11662-def8-4dde-9ebc-4429e68d130e
érvényesíti az alap Beteg erőforráshoz. Ha ez érvényes, az alábbi példakódhoz hasonlót fog kapni OperationOutcome
:
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "information",
"code": "informational",
"diagnostics": "All OK"
}
]
}
Ha az erőforrás érvénytelen, hibaüzenet jelenik meg, amely részletesen ismerteti, hogy miért érvénytelen az erőforrás. A rendszer hibaüzenetekkel ad vissza egy példát OperationOutcome
, és az alábbi példakódhoz hasonlóan nézhet ki:
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "invalid",
"details": {
"coding": [
{
"system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
"code": "1028"
}
],
"text": "Instance count for 'Patient.identifier.value' is 0, which is not within the specified cardinality of 1..1"
},
"location": [
"Patient.identifier[1]"
]
},
{
"severity": "error",
"code": "invalid",
"details": {
"coding": [
{
"system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
"code": "1028"
}
],
"text": "Instance count for 'Patient.gender' is 0, which is not within the specified cardinality of 1..1"
},
"location": [
"Patient"
]
}
]
}
Ebben a példában az erőforrás nem felelt meg a megadott betegprofilnak, amelyhez egy betegazonosító értékre és nemre volt szükség.
Ha paraméterként szeretne megadni egy profilt, megadhatja az érvényesítendő profil canonical URL-címét, például a következő példát a HL7 alapprofilhoz heartrate
:
GET https://myAzureAPIforFHIR.azurehealthcareapis.com/Observation/12345678/$validate?profile=http://hl7.org/fhir/StructureDefinition/heartrate
Új erőforrás érvényesítése
Ha ellenőrizni szeretné, hogy egy új erőforrást tölt-e fel az Azure API for FHIR-be, akkor egy kérést is elvégezhet POST
: A kiszolgáló ennek eredményeként mindig egy OperationOutcome-t ad vissza.
POST http://<your Azure API for FHIR base URL>/{Resource}/$validate
Példa:
POST https://myAzureAPIforFHIR.azurehealthcareapis.com/Patient/$validate
Ez a kérés ellenőrzi az erőforrást. Ha az érvényesítési erőforrások nem jönnek létre az FHIR szolgáltatásban, akkor post kérelmet kell küldenie anélkül, hogy $validate kellene létrehoznia az erőforrást.
Az erőforrás LÉTREHOZÁS/FRISSÍTÉS ellenőrzése fejléc használatával.
Alapértelmezés szerint az Azure API for FHIR úgy van konfigurálva, hogy letiltsa az érvényesítést az erőforráson Create/Update
. Ez a funkció lehetővé teszi, hogy a fejléc használatával ellenőrizze a be- és bekapcsolvaCreate/Update
x-ms-profile-validation
. Állítsa az "x-ms-profile-validation" értéket igaz értékre az ellenőrzéshez.
Feljegyzés
A nyílt forráskódú FHIR szolgáltatásban módosíthatja a kiszolgáló konfigurációs beállításait a CoreFeatures alatt.
{
"FhirServer": {
"CoreFeatures": {
"ProfileValidationOnCreate": true,
"ProfileValidationOnUpdate": false
}
}
Következő lépések
Ebben a cikkben megtanulhatta, hogyan érvényesítheti az erőforrásokat a profilok alapján $validate
. Az FHIR-hez készült egyéb Azure API-kkal kapcsolatos további információkért lásd:
Az FHIR® a HL7 bejegyzett védjegye, amelyet a HL7 engedélyével használnak.