This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Raw Turtle (+ also see Turtle/RDF Format Specification)
Operation Definition
@prefix fhir: <http://hl7.org/fhir/> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . # - resource ------------------------------------------------------------------- [] a fhir:OperationDefinition; fhir:Resource.id [ fhir:value "DocumentReference-generate"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "extensions" ] ]; fhir:DomainResource.extension [ fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ]; fhir:Extension.value [ fhir:value "3" ] ], [ fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "trial-use" ] ]; fhir:CanonicalResource.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/DocumentReference-generate"]; fhir:CanonicalResource.version [ fhir:value "4.5.0"]; fhir:CanonicalResource.name [ fhir:value "Generate a DocumentReference from a document"]; fhir:CanonicalResource.status [ fhir:value "draft"]; fhir:CanonicalResource.date [ fhir:value "2020-08-20T17:41:31+10:00"]; fhir:CanonicalResource.publisher [ fhir:value "HL7 (FHIR Project)"]; fhir:CanonicalResource.contact [ fhir:ContactDetail.telecom [ fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ], [ fhir:ContactPoint.system [ fhir:value "email" ]; fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ] ] ]; fhir:CanonicalResource.description [ fhir:value "A client can ask a server to generate a document reference from a document.\nThe server reads the existing document and generates a matching DocumentReference\nresource, or returns one it has previously generated. Servers may be able to \nreturn or generate document references for the following types of content:"]; fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/DocumentReference-generate"]; fhir:OperationDefinition.version [ fhir:value "4.5.0"]; fhir:OperationDefinition.name [ fhir:value "Generate a DocumentReference from a document"]; fhir:OperationDefinition.status [ fhir:value "draft"]; fhir:OperationDefinition.kind [ fhir:value "operation"]; fhir:OperationDefinition.date [ fhir:value "2020-08-20T17:41:31+10:00"]; fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"]; fhir:OperationDefinition.contact [ fhir:ContactDetail.telecom [ fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ], [ fhir:ContactPoint.system [ fhir:value "email" ]; fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ] ] ]; fhir:OperationDefinition.description [ fhir:value "A client can ask a server to generate a document reference from a document.\nThe server reads the existing document and generates a matching DocumentReference\nresource, or returns one it has previously generated. Servers may be able to \nreturn or generate document references for the following types of content:"]; fhir:OperationDefinition.code [ fhir:value "generate"]; fhir:OperationDefinition.comment [ fhir:value "The server either returns a search result containing a single document reference, \nor it returns an error. \nIf the URI refers to another server, it is at the discretion of the \nserver whether to retrieve it or return an error."]; fhir:OperationDefinition.resource [ fhir:value "DocumentReference"]; fhir:OperationDefinition.system [ fhir:value "false"]; fhir:OperationDefinition.type [ fhir:value "true"]; fhir:OperationDefinition.instance [ fhir:value "false"]; fhir:OperationDefinition.parameter [ fhir:OperationDefinitionParameterComponent.name [ fhir:value "url" ]; fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ]; fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ]; fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ]; fhir:OperationDefinitionParameterComponent.type [ fhir:value "uri" ] ], [ fhir:OperationDefinitionParameterComponent.name [ fhir:value "persist" ]; fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ]; fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ]; fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ]; fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "Whether to store the document at the document end-point (/Document) or not, once it is generated (default is for the server to decide)." ]; fhir:OperationDefinitionParameterComponent.type [ fhir:value "Binary" ] ], [ fhir:OperationDefinitionParameterComponent.name [ fhir:value "docRef" ]; fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ]; fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ]; fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ]; fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The server either returns a single document reference, or it returns an error. If the input url refers to another server, it is at the discretion of the server whether to retrieve it or return an error." ]; fhir:OperationDefinitionParameterComponent.type [ fhir:value "DocumentReference" ] ] . # -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.