선택 가능한 검색 매개 변수(미리 보기)

Important

선택 가능한 검색 매개 변수 기능은 미리 보기로 사용할 수 있습니다. 미리 보기 API 및 SDK는 SLA(서비스 수준 계약) 없이 제공됩니다. 프로덕션 워크로드에는 사용하지 않는 것이 좋습니다. 일부 기능은 지원되지 않거나 기능이 제한될 수 있습니다. 자세한 내용은 Microsoft Azure Preview에 대한 추가 사용 약관을 참조하세요.

리소스 검색은 FHIR® 서비스의 기본 사항입니다. FHIR 서비스의 각 리소스는 정보를 요소 집합으로 전달합니다. 검색 매개 변수는 이러한 요소의 정보를 쿼리하는 데 작동합니다. FHIR 서비스가 배포되면 기본적으로 기본으로 작성된 검색 매개 변수 가 사용하도록 설정됩니다. FHIR 서비스는 데이터를 수집하는 동안 FHIR 리소스에서 특정 속성을 추출하고 인덱싱하여 효율적인 검색을 수행합니다.

선택 가능한 검색 매개 변수를 사용하면 붙지 않는 검색 매개 변수를 사용하거나 사용하지 않도록 설정할 수 있습니다. 이 기능을 사용하면 필요한 검색 매개 변수만 사용하도록 설정하여 할당된 스토리지 공간에 더 많은 리소스를 저장하고 성능을 향상시킬 수 있습니다.

검색 매개 변수에서 상태 업데이트를 수행하려면 다음 단계를 수행합니다.

1. 검색 매개 변수의 상태를 가져옵니다.
2. 검색 매개 변수의 상태를 업데이트합니다.
3. 다시 인덱스 작업을 실행합니다.

이 문서에서는 FHIR 서버 URL을 나타내는 {{FHIR_URL}} 자리 표시자를 사용하여 API 호출 예제에서 FHIR 검색 구문을 보여 줍니다.

검색 매개 변수의 상태 가져오기

검색 매개 변수의 상태를 보려면 API 엔드포인트('$status')가 제공됩니다. 응답에 대한 4가지 상태가 있습니다.

Status	설명
지원 여부	검색 매개 변수는 FHIR 서비스에서 지원되며 검색 매개 변수를 사용하도록 설정하는 요청을 제출했습니다. 다시 인덱스 작업을 실행하여 지원되는 작업에서 사용하도록 설정합니다.
사용	검색 매개 변수를 검색할 수 있습니다. 이 상태는 지원되는 상태 다음 단계입니다.
PendingDisable	다시 인덱스 작업을 실행한 후 검색 매개 변수를 사용하지 않도록 설정이 보류 중입니다.
사용 안 함	검색 매개 변수를 사용할 수 없습니다.

모든 검색 매개 변수에서 상태를 얻으려면 모든 검색 매개 변수 및 해당 상태 목록을 반환하는 다음 요청을 사용합니다. 목록을 스크롤하여 필요한 검색 매개 변수를 찾습니다.

GET {{FHIR_URL}}/SearchParameter/$status

검색 매개 변수의 개별 또는 하위 집합의 상태를 식별하려면 다음 필터를 사용합니다.

• Name(이름): 이름으로 검색 매개 변수 상태를 식별하려면 이 요청을 사용합니다.

   GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>

• URL. 정식 식별자별로 검색 매개 변수 상태를 식별하려면 이 요청을 사용합니다.

GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>

• 리소스 종류. FHIR에서는 개별 리소스 수준에서 검색 매개 변수를 사용하도록 설정하여 특정 리소스 하위 집합을 필터링하고 검색할 수 있습니다. 리소스에 매핑된 모든 검색 매개 변수의 상태를 식별하려면 이 요청을 사용합니다.

GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>

$status 엔드포인트에 대한 GET 요청에 대한 응답으로 매개 변수 리소스 종류가 검색 매개 변수의 상태와 함께 반환됩니다. 다음은 응답 예제입니다.

{
  "resourceType" : "Parameters",
  "parameter" : [
    "name" : "searchParameterStatus",
    "part" : {
        {
        "name" : "url",
        "valueString" : "http://hl7.org/fhir/SearchParameter/Account-identifier"
        },
        {
        "name" : "status",
        "valueString" : "supported"
        }
    }
  ]
}

검색 매개 변수의 상태 업데이트

검색 매개 변수의 상태가 표시되면 검색 매개 변수 Supported 의 상태를 업데이트합니다 Disabled.

참고 항목

검색 매개 변수의 상태를 업데이트하려면 Search 매개 변수 관리자 Azure RBAC 역할이 필요합니다.

검색 매개 변수 상태는 단일 검색 매개 변수 또는 대량으로 업데이트할 수 있습니다.

단일 검색 매개 변수 상태 업데이트

단일 검색 매개 변수의 상태를 업데이트하려면 다음 API 요청을 사용합니다.

PUT {{FHIR_URL}}/SearchParameter/$status
{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "searchParameterStatus",
            "part": [
                {
                    "name": "url",
                    "valueUrl": "http://hl7.org/fhir/SearchParameter/Resource-test-id"
                },
                {
                    "name": "status",
                    "valueString": "Supported"
                }
            ]
        }
    ]
}

사용 사례에 따라 검색 매개 변수에 대해 상태 상태 값을 '지원됨' 또는 '사용 안 함'으로 유지할 수 있습니다. 요청에서 상태를 Disabled 보내면 연결을 완전히 제거하기 위해 다시 인덱스 작업을 실행해야 하기 때문에 응답이 반환 PendingDisable 됩니다.

응답에서 400 HTTP 상태 코드를 받으면 식별된 검색 매개 변수에 대한 고유한 일치 항목이 없음을 의미합니다. 검색 매개 변수 ID를 확인합니다.

검색 매개 변수 상태를 대량으로 업데이트

검색 매개 변수의 상태를 대량으로 업데이트하려면 'PUT' 요청에 요청 본문에 '매개 변수' 리소스 목록이 있어야 합니다. 목록에는 업데이트해야 하는 개별 검색 매개 변수가 포함되어야 합니다.

PUT {{FHIR_URL}}/SearchParameter/$status
{
  "resourceType" : "Parameters",
  "parameter" : [
    {
     "name" : "searchParameterStatus",
     "part" :{
        "name" : "url",
        "valueString" : "http://hl7.org/fhir/SearchParameter/Endpoint-name"
     },
     "part":{ 
        "name" : "status",
        "valueString" : "supported"
     }
    },
         "name" : "searchParameterStatus",
     "part" :{
        "name" : "url",
        "valueString" : "http://hl7.org/fhir/SearchParameter/HealthcareService-name"
     },
     "part":{ 
        "name" : "status",
        "valueString" : "supported"
     }
    },
    ...
  ]
}

다시 인덱스 작업 실행

검색 매개 변수 상태를 Supported 업데이트하거나 Disabled업데이트한 후 다음 단계는 다시 인덱스 작업을 실행하는 것입니다.

검색 매개 변수가 인덱싱될 Enabled 때까지 검색 매개 변수의 상태 및 Disabled 상태가 활성화되지 않습니다. 작업 실행을 다시 인덱싱하면 상태를 Supported 업데이트합니다 PendingDisable Enabled Disabled.

전체 FHIR 서비스 데이터베이스 또는 특정 검색 매개 변수에 대해 다시 인덱스 작업을 실행할 수 있습니다. 다시 인덱스 작업은 성능 집약적일 수 있습니다. 자세한 내용은 다시 인덱스 작업 실행을 참조 하세요.

참고 항목

기능 문 문서는 FHIR 서버에 대한 동작 집합입니다. Enabled 검색 매개 변수는 FHIR 서비스의 기능 문에 나열됩니다. /metadata 엔드포인트에 기능 문을 사용할 수 있습니다.

질문과 대답

쿼리에 '지원됨' 상태의 검색 매개 변수가 포함된 경우의 동작은 무엇인가요?

'지원됨' 상태의 검색 매개 변수를 다시 인덱싱해야 합니다. 그때까지 검색 매개 변수는 활성화되지 않습니다. 비활성 검색 매개 변수에서 쿼리가 실행되는 경우 FHIR 서비스는 해당 검색 매개 변수를 고려하지 않고 응답을 렌더링합니다. 응답에는 검색 매개 변수가 인덱싱되지 않았으며 쿼리에서 사용되지 않음을 나타내는 경고 메시지가 표시됩니다. 이러한 상황에서 오류를 렌더링하려면 값이 'strict'인 'Prefer: handling' 헤더를 사용합니다. 이 헤더를 설정하면 경고가 오류로 보고됩니다.

다음 단계

사용자 지정 검색 매개 변수 정의

참고 항목

FHIR®은 HL7의 등록 상표이며, HL7의 사용 허가 하에 사용됩니다.