FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/find-study-metadata

Packagehl7.fhir.uv.genomics-reporting
Resource TypeOperationDefinition
Idfind-study-metadata
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/genomics-reporting/https://build.fhir.org/ig/HL7/genomics-reporting/OperationDefinition-find-study-metadata.html
URLhttp://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-study-metadata
Version4.0.0-ballot
Statusactive
Date2025-06-24T17:31:37+00:00
NameFindStudyMetadata
TitleFind Study Metadata
Realmuv
Authorityhl7
DescriptionRetrieve metadata about sequencing studies performed on a subject.
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition find-study-metadata

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsubject1..1string
(reference)

The subject of interest.

INtestIdentifiers0..*string
(token)

List of test identifiers. Metadata for each test is returned.

INtestDateRange0..1Period

Metadata for each test performed during the range is returned.

INspecimenIdentifiers0..*string
(token)

List of specimen identifiers. Metadata for each test based on a supplied specimen identifier is returned.

INranges0..*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').

OUTtests0..*
OUTtests.testId1..1string

test identifier

OUTtests.testDate1..1dateTime

test date

OUTtests.specimenId0..1string

specimen identifier

OUTtests.genomicBuild0..1CodeableConcept

preferred codes: https://loinc.org/LL1040-6/

OUTtests.dnaChangeType0..1CodeableConcept

preferred codes: http://www.sequenceontology.org/browser/current_release/term/SO:0002072

OUTtests.regionStudied0..1string

List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'

OUTtests.uncallableRegions0..1string

List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'


Source

{
  "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"
        }
      ]
    }
  ]
}