| Package | hl7.fhir.uv.genomics-reporting |
| Resource Type | OperationDefinition |
| Id | find-study-metadata |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/genomics-reporting/https://build.fhir.org/ig/HL7/genomics-reporting/OperationDefinition-find-study-metadata.html |
| URL | http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-study-metadata |
| Version | 4.0.0-ballot |
| Status | active |
| Date | 2025-06-24T17:31:37+00:00 |
| Name | FindStudyMetadata |
| Title | Find Study Metadata |
| Realm | uv |
| Authority | hl7 |
| Description | Retrieve metadata about sequencing studies performed on a subject. |
| Type | true |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition find-study-metadata
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | subject | 1..1 | string (reference) | The subject of interest. | ||
| IN | testIdentifiers | 0..* | string (token) | List of test identifiers. Metadata for each test is returned. | ||
| IN | testDateRange | 0..1 | Period | Metadata for each test performed during the range is returned. | ||
| IN | specimenIdentifiers | 0..* | string (token) | List of specimen identifiers. Metadata for each test based on a supplied specimen identifier is returned. | ||
| IN | ranges | 0..* | string (special) | List of regions for which additional study information is sought. If ranges are supplied, then each returned test will include studied and uncallable regions. Must be in zero-based RefSeq:Integer-range format (e.g. 'NC_000007.14:55174721-55174820'). | ||
| OUT | tests | 0..* | ||||
| OUT | tests.testId | 1..1 | string | test identifier | ||
| OUT | tests.testDate | 1..1 | dateTime | test date | ||
| OUT | tests.specimenId | 0..1 | string | specimen identifier | ||
| OUT | tests.genomicBuild | 0..1 | CodeableConcept | preferred codes: https://loinc.org/LL1040-6/ | ||
| OUT | tests.dnaChangeType | 0..1 | CodeableConcept | preferred codes: http://www.sequenceontology.org/browser/current_release/term/SO:0002072 | ||
| OUT | tests.regionStudied | 0..1 | string | List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown' | ||
| OUT | tests.uncallableRegions | 0..1 | string | List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown' |
{
"resourceType": "OperationDefinition",
"id": "find-study-metadata",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cg"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/genomics-reporting/ImplementationGuide/genomics-reporting"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/genomics-reporting/ImplementationGuide/genomics-reporting"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-study-metadata",
"version": "4.0.0-ballot",
"name": "FindStudyMetadata",
"title": "Find Study Metadata",
"status": "active",
"kind": "operation",
"date": "2025-06-24T17:31:37+00:00",
"publisher": "HL7 International / Clinical Genomics",
"contact": [
{
"name": "HL7 International / Clinical Genomics",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/clingenomics"
},
{
"system": "email",
"value": "cg@lists.HL7.org"
}
]
}
],
"description": "Retrieve metadata about sequencing studies performed on a subject.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"code": "match",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "subject",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The subject of interest.",
"type": "string",
"searchType": "reference"
},
{
"name": "testIdentifiers",
"use": "in",
"min": 0,
"max": "*",
"documentation": "List of test identifiers. Metadata for each test is returned.",
"type": "string",
"searchType": "token"
},
{
"name": "testDateRange",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Metadata for each test performed during the range is returned.",
"type": "Period"
},
{
"name": "specimenIdentifiers",
"use": "in",
"min": 0,
"max": "*",
"documentation": "List of specimen identifiers. Metadata for each test based on a supplied specimen identifier is returned.",
"type": "string",
"searchType": "token"
},
{
"name": "ranges",
"use": "in",
"min": 0,
"max": "*",
"documentation": "List of regions for which additional study information is sought. If ranges are supplied, then each returned test will include studied and uncallable regions. Must be in zero-based RefSeq:Integer-range format (e.g. 'NC_000007.14:55174721-55174820').",
"type": "string",
"searchType": "special"
},
{
"name": "tests",
"use": "out",
"min": 0,
"max": "*",
"part": [
{
"name": "testId",
"use": "out",
"min": 1,
"max": "1",
"documentation": "test identifier",
"type": "string"
},
{
"name": "testDate",
"use": "out",
"min": 1,
"max": "1",
"documentation": "test date",
"type": "dateTime"
},
{
"name": "specimenId",
"use": "out",
"min": 0,
"max": "1",
"documentation": "specimen identifier",
"type": "string"
},
{
"name": "genomicBuild",
"use": "out",
"min": 0,
"max": "1",
"documentation": "preferred codes: https://loinc.org/LL1040-6/",
"type": "CodeableConcept"
},
{
"name": "dnaChangeType",
"use": "out",
"min": 0,
"max": "1",
"documentation": "preferred codes: http://www.sequenceontology.org/browser/current_release/term/SO:0002072",
"type": "CodeableConcept"
},
{
"name": "regionStudied",
"use": "out",
"min": 0,
"max": "1",
"documentation": "List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'",
"type": "string"
},
{
"name": "uncallableRegions",
"use": "out",
"min": 0,
"max": "1",
"documentation": "List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'",
"type": "string"
}
]
}
]
}