Release 5 R6 Ballot (3rd Draft)
This page is part of the FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Publish-box (todo)

Example OperationDefinition/DocumentReference-generate (Turtle)

Orders and Observations Work Group Maturity Level : N/A Standards Status : Informative

Raw Turtle (+ also see Turtle/RDF Format Specification )

Operation Definition 

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .

@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .


# - resource -------------------------------------------------------------------

[] a fhir:OperationDefinition ;
  fhir:id [ fhir:v "DocumentReference-generate"] ;

<http://hl7.org/fhir/OperationDefinition/DocumentReference-generate> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "DocumentReference-generate"] ; # 

  fhir:text [
     fhir:status [ fhir:v "extensions" ]
  ] ;

     fhir:status [ fhir:v "generated" ] ;
     fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition DocumentReference-generate</b></p><a name=\"DocumentReference-generate\"> </a><a name=\"hcDocumentReference-generate\"> </a><a name=\"DocumentReference-generate-en-AU\"> </a><p>URL: [base]/DocumentReference/$generate</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>url</td><td/><td>1..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>The URL to the source document. This may be a general URL or a Binary or a Composition or a Bundle.</p>\n</div></td></tr><tr><td>IN</td><td>persist</td><td/><td>0..1</td><td><a href=\"datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Whether to store the document at the document end-point (/Document) or not, once it is generated (default is for the server to decide).</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"bundle.html\">Bundle</a></td><td/><td><div><p>The bundle type is &quot;searchset&quot;containing <a href=\"documentreference.html\">DocumentReference</a> 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.</p>\n</div></td></tr></table><div><p>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.</p>\n</div></div>"^^rdf:XMLLiteral
  ] ; # 

  fhir:extension ( [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
     fhir:value [ fhir:v "3" ]

     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
     fhir:value [
       a fhir:integer ;
       fhir:v 3
     ]

  ] [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
     fhir:value [ fhir:v "trial-use" ]
  ] ) ;
  fhir:url [ fhir:v "http://hl7.org/fhir/OperationDefinition/DocumentReference-generate"], [ fhir:v "http://hl7.org/fhir/OperationDefinition/DocumentReference-generate"] ;
  fhir:version [ fhir:v "5.0.0"], [ fhir:v "5.0.0"] ;
  fhir:name [ fhir:v "Generate"], [ fhir:v "Generate"] ;
  fhir:title [ fhir:v "Generate a DocumentReference from a document"], [ fhir:v "Generate a DocumentReference from a document"] ;
  fhir:status [ fhir:v "draft"], [ fhir:v "draft"] ;
  fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
  fhir:date [ fhir:v "2023-03-26T15:21:02+11:00"], [ fhir:v "2023-03-26T15:21:02+11:00"] ;
  fhir:publisher [ fhir:v "HL7 (FHIR Project)"], [ fhir:v "HL7 (FHIR Project)"] ;

     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
     fhir:value [
       a fhir:code ;
       fhir:v "trial-use"
     ]
  ] [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
     fhir:value [
       a fhir:code ;
       fhir:v "oo"
     ]
  ] ) ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/OperationDefinition/DocumentReference-generate"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "6.0.0-ballot3"] ; # 
  fhir:name [ fhir:v "Generate"] ; # 
  fhir:title [ fhir:v "Generate a DocumentReference from a document"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:kind [ fhir:v "operation"] ; # 
  fhir:experimental [ fhir:v false] ; # 
  fhir:date [ fhir:v "2025-04-01T12:16:37+11:00"^^xsd:dateTime] ; # 
  fhir:publisher [ fhir:v "HL7 International / Orders and Observations"] ; # 

  fhir:contact ( [
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://hl7.org/fhir" ]
     ] [
       fhir:system [ fhir:v "email" ] ;
       fhir:value [ fhir:v "fhir@lists.hl7.org" ]
     ] )
  ] [
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://hl7.org/fhir" ]
     ] [
       fhir:system [ fhir:v "email" ] ;
       fhir:value [ fhir:v "fhir@lists.hl7.org" ]

       fhir:value [ fhir:v "http://www.hl7.org/Special/committees/orders" ]

     ] )
  ] ) ;
  fhir:description [ fhir:v "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:v "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:description [ fhir:v "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:jurisdiction ( [
     fhir:coding ( [
       fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
       fhir:code [ fhir:v "001" ] ;
       fhir:display [ fhir:v "World" ]
     ] )
  ] [
     fhir:coding ( [
       fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;

       fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;

       fhir:code [ fhir:v "001" ] ;
       fhir:display [ fhir:v "World" ]
     ] )
  ] ) ;
  fhir:kind [ fhir:v "operation"] ;
  fhir:affectsState [ fhir:v "true"] ;
  fhir:code [ fhir:v "generate"] ;
  fhir:comment [ fhir:v "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:resource ( [ fhir:v "DocumentReference"] ) ;
  fhir:system [ fhir:v "false"] ;
  fhir:type [ fhir:v "true"] ;
  fhir:instance [ fhir:v "false"] ;

  ] ) ; # 
  fhir:affectsState [ fhir:v true] ; # 
  fhir:code [ fhir:v "generate"] ; # 
  fhir:comment [ fhir:v "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:resource ( [ fhir:v "DocumentReference"] ) ; # 
  fhir:system [ fhir:v false] ; # 
  fhir:type [ fhir:v true] ; # 
  fhir:instance [ fhir:v false] ; # 

  fhir:parameter ( [
     fhir:name [ fhir:v "url" ] ;
     fhir:use [ fhir:v "in" ] ;
     fhir:min [ fhir:v "1" ] ;

     fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ;

     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "The URL to the source document. This may be a general URL or a Binary or a Composition or a Bundle." ] ;
     fhir:type [ fhir:v "uri" ]
  ] [
     fhir:name [ fhir:v "persist" ] ;
     fhir:use [ fhir:v "in" ] ;
     fhir:min [ fhir:v "0" ] ;

     fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;

     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "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:type [ fhir:v "boolean" ]
  ] [
     fhir:name [ fhir:v "return" ] ;
     fhir:use [ fhir:v "out" ] ;
     fhir:min [ fhir:v "1" ] ;

     fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ;

     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "The bundle type is \"searchset\"containing [DocumentReference](documentreference.html) 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." ] ;
     fhir:type [ fhir:v "Bundle" ]
  ] ) .

  ] ) . # 


# -------------------------------------------------------------------------------------

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.