PackagesCanonicalsLogsProblems
    Packages
    uk.nhsengland.genomics.r4@0.4.0-prerelease
    https://fhir.nhs.uk/OperationDefinition/genomics-generate
{
  "description": "An operation used to generate a DocumentReference resource for a genomic data file, optionally pulling the referenced data file to a central data store and generating a DRS url for the data file.\\r\\nCustomised backport of the R5 DocumentReference-generate OperationDefinition: http://hl7.org/fhir/OperationDefinition/DocumentReference-generate.\\r\\nSpecific profiles for input or output parameters, e.g. for certain data file types, are pending further investigation by GEL.",
  "_filename": "OperationDefinition-genomics-generate.json",
  "package_name": "uk.nhsengland.genomics.r4",
  "date": "2024-09-04",
  "system": false,
  "publisher": "NHS England",
  "instance": false,
  "name": "GenomicsGenerate",
  "type": "true",
  "experimental": "false",
  "resourceType": "OperationDefinition",
  "title": null,
  "package_version": "0.4.0-prerelease",
  "status": "draft",
  "id": "2512b7ca-faf7-4018-867f-50d8eaddc76e",
  "resource": [ "DocumentReference" ],
  "affectsState": true,
  "kind": "operation",
  "url": "https://fhir.nhs.uk/OperationDefinition/genomics-generate",
  "code": "genomics-generate",
  "version": "0.0.1",
  "parameter": [ {
    "max": "1",
    "min": 1,
    "use": "in",
    "name": "url",
    "type": "uri",
    "documentation": "The URL to the source document. This may be a general URL or a Binary or a Composition or a Bundle.\r\nFor a Genomic Data File, MUST be either a DRS URL or a presigned URL."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "persist",
    "type": "boolean",
    "documentation": "Whether to store the document at the document end-point (/Document) or not, once it is generated (default is for the server to decide).\r\nFor a Genomic Data File, determines whether the data file will be pulled to a central data store, or will remain on the source server. \r\nIn all cases, the DocumentReference will be generated and stored on the server at the /DocumentReference endpoint."
  }, {
    "max": "1",
    "min": 1,
    "use": "in",
    "name": "content-type",
    "type": "string",
    "documentation": "MIME type for the file. Used to determine how the reference should be processed and which context references are required."
  }, {
    "max": "*",
    "min": 0,
    "use": "in",
    "name": "context-reference",
    "type": "Reference",
    "documentation": "Reference to FHIR resource which provide context for the DocumentReference e.g. ServiceRequest which initiated the collection of the data file, or the Specimen from which it originated.",
    "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest", "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Specimen" ]
  }, {
    "max": "1",
    "min": 1,
    "use": "in",
    "name": "author",
    "type": "Identifier",
    "documentation": "ODS code for the author organization."
  }, {
    "max": "1",
    "min": 1,
    "use": "out",
    "name": "return",
    "type": "Bundle",
    "documentation": "The bundle type is \"searchset\" containing DocumentReference resource and may include a Binary. If the input url refers to another server, it is at the discretion of the server whether to retrieve it or return an error."
  } ]
}