Fujitsu Healthy Living Implementation Guide
1.1.28 - release

Publication Build: This will be filled in by the publication tooling

: Fujitsu DocumentReference ($docref) - JSON Representation

Active as of 2025-07-09

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "fujitsu-operation-documentreference-docref",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/DocumentReference/$docref</p><p>Parameters</p><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>patient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#id\">id</a></td><td/><td><div><p>The id of the patient resource located on the server on which this operation is executed. If there is no match, an empty Bundle is returned<br/>\n(この操作が実行されるサーバー上にある患者リソースの ID。一致するものがない場合は、空のバンドルが返されます。)</p>\n</div></td></tr><tr><td>IN</td><td>start</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.<br/>\n(日付範囲は、記録の日付ではなく、ケアの日付に関連しています - 例えば、特定の日付範囲で提供されるケアに関連するすべてのレコード。開始日を指定しない場合、終了日より前のすべてのドキュメントがスコープ内に入ります。開始日も終了日も指定しない場合、最新または最新のドキュメントがスコープ内にあります。クライアントは、2番目の+時間オフセットに正確な値を提供する必要があります(SHOULD)。)</p>\n</div></td></tr><tr><td>IN</td><td>end</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.<br/>\n(日付範囲は、記録の日付ではなく、ケアの日付に関連しています - 例えば、特定の日付範囲で提供されるケアに関連するすべてのレコード。終了日を指定しない場合、開始日より後のすべてのドキュメントがスコープ内に入ります。開始日も終了日も指定しない場合、最新または最新のドキュメントがスコープ内にあります。クライアントは、2番目の+時間オフセットに正確な値を提供する必要があります(SHOULD)。)</p>\n</div></td></tr><tr><td>IN</td><td>type</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td/><td><div><p>The type of document being requested. It relates to document type, e.g. the LOINC code for a C-CDA Continuity of Care Document (CCD) is 34133-9 (Summary of episode note). If no type is provided, a CDA document, if available, SHOULD be in scope and all other document types MAY be in scope<br/>\n(要求されているドキュメントの種類。これは文書タイプに関連し、例えば、C-CDAケア文書の連続性(CCD)のLOINCコードは34133-9(エピソードノートの要約)である。タイプが指定されていない場合、CDAドキュメントは、利用可能な場合、スコープ内にあり、他のすべてのドキュメントタイプはスコープ内にある必要があります(MAY)。)</p>\n</div></td></tr><tr><td>IN</td><td>on-demand</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>This on-demand parameter allows client to dictate whether they are requesting only 'on-demand' or both 'on-demand' and 'stable' documents (or delayed/deferred assembly) that meet the query parameters<br/>\nこのオンデマンド パラメーターを使用すると、クライアントは、クエリ パラメーターを満たす 'on-demand' ドキュメントまたは、'on-demand' ドキュメントと 'stable' ドキュメントの両方(または遅延/遅延アセンブリ)を要求するかを指示できます。</p>\n</div></td></tr><tr><td>IN</td><td>pofile</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>This parameter allows the client to request documents according to a specific profile, using the the profile's canonical reference<br/>\n(このパラメーターを使用すると、クライアントは、プロファイルの正規参照を使用して、特定のプロファイルに従って文書を要求できます。)</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The bundle type is &quot;searchset&quot;containing DocumentReference resources which SHOULD conform to the IPA profile of DocumentReference<br/>\n(バンドルタイプは 'searchset' で、ドキュメントリファレンスの IPA プロファイルに準拠する (SHOULD) ドキュメントリファレンスリソースが含まれています(SHOULD)。)</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://ig.fujitsu.com/healthy-living/OperationDefinition/fujitsu-operation-documentreference-docref",
  "version" : "1.1.28",
  "name" : "Fujitsu DocumentReference",
  "title" : "Fujitsu DocumentReference ($docref)",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-07-09T03:03:47+00:00",
  "publisher" : "Fujitsu",
  "contact" : [
    {
      "name" : "Fujitsu",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://hlpf.global.fujitsu.com/top/"
        }
      ]
    }
  ],
  "description" : "DocumentReference Operation (文書参照オペレーション)",
  "code" : "docref",
  "resource" : [
    "DocumentReference"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The id of the patient resource located on the server on which this operation is executed. If there is no match, an empty Bundle is returned  \n(この操作が実行されるサーバー上にある患者リソースの ID。一致するものがない場合は、空のバンドルが返されます。)",
      "type" : "id"
    },
    {
      "name" : "start",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.  \n(日付範囲は、記録の日付ではなく、ケアの日付に関連しています - 例えば、特定の日付範囲で提供されるケアに関連するすべてのレコード。開始日を指定しない場合、終了日より前のすべてのドキュメントがスコープ内に入ります。開始日も終了日も指定しない場合、最新または最新のドキュメントがスコープ内にあります。クライアントは、2番目の+時間オフセットに正確な値を提供する必要があります(SHOULD)。)",
      "type" : "dateTime"
    },
    {
      "name" : "end",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.  \n(日付範囲は、記録の日付ではなく、ケアの日付に関連しています - 例えば、特定の日付範囲で提供されるケアに関連するすべてのレコード。終了日を指定しない場合、開始日より後のすべてのドキュメントがスコープ内に入ります。開始日も終了日も指定しない場合、最新または最新のドキュメントがスコープ内にあります。クライアントは、2番目の+時間オフセットに正確な値を提供する必要があります(SHOULD)。)",
      "type" : "dateTime"
    },
    {
      "name" : "type",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The type of document being requested. It relates to document type, e.g. the LOINC code for a C-CDA Continuity of Care Document (CCD) is 34133-9 (Summary of episode note). If no type is provided, a CDA document, if available, SHOULD be in scope and all other document types MAY be in scope  \n(要求されているドキュメントの種類。これは文書タイプに関連し、例えば、C-CDAケア文書の連続性(CCD)のLOINCコードは34133-9(エピソードノートの要約)である。タイプが指定されていない場合、CDAドキュメントは、利用可能な場合、スコープ内にあり、他のすべてのドキュメントタイプはスコープ内にある必要があります(MAY)。)",
      "type" : "CodeableConcept"
    },
    {
      "name" : "on-demand",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "This on-demand parameter allows client to dictate whether they are requesting only 'on-demand' or both 'on-demand' and 'stable' documents (or delayed/deferred assembly) that meet the query parameters  \nこのオンデマンド パラメーターを使用すると、クライアントは、クエリ パラメーターを満たす 'on-demand' ドキュメントまたは、'on-demand' ドキュメントと 'stable' ドキュメントの両方(または遅延/遅延アセンブリ)を要求するかを指示できます。",
      "type" : "boolean"
    },
    {
      "name" : "pofile",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "This parameter allows the client to request documents according to a specific profile, using the the profile's canonical reference  \n(このパラメーターを使用すると、クライアントは、プロファイルの正規参照を使用して、特定のプロファイルに従って文書を要求できます。)",
      "type" : "canonical"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The bundle type is \\\"searchset\\\"containing DocumentReference resources which SHOULD conform to the IPA profile of DocumentReference  \n(バンドルタイプは 'searchset' で、ドキュメントリファレンスの IPA プロファイルに準拠する (SHOULD) ドキュメントリファレンスリソースが含まれています(SHOULD)。)",
      "type" : "Bundle"
    }
  ]
}