Sequoia Project Healthcare Directory Implementation Guide
1.18.0 - Release 1
Sequoia Project Healthcare Directory Implementation Guide
1.18.0 - Release 1
{
"resourceType" : "Endpoint",
"id" : "fhir-endpoint",
"meta" : {
"profile" : [
🔗 "https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaEndpoint"
]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Endpoint fhir-endpoint</b></p><a name=\"fhir-endpoint\"> </a><a name=\"hcfhir-endpoint\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-SequoiaEndpoint.html\">Sequoia Endpoint</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">patient query (HL7 FHIR (Endpoint Connection Type#hl7-fhir-rest)): https://example.org/fhir</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"The status of the endpoint\">Status:</td><td colspan=\"3\">Active</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The technical base address for connecting to this endpoint\">Address:</td><td colspan=\"3\"><a href=\"https://example.org/fhir\">https://example.org/fhir</a></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The protocol, profile or standard used to connect to the endpoint\">Connection Type:</td><td colspan=\"3\"><a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-endpoint-connection-type.html#endpoint-connection-type-hl7-fhir-rest\">Endpoint Connection Type: hl7-fhir-rest</a> (HL7 FHIR)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The type of content that may be used at this endpoint\">Payload Type:</td><td colspan=\"3\"><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-NullFlavor NI}\">NoInformation</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The organization that manages this endpoint\">Managed By:</td><td colspan=\"3\"><a href=\"Organization-5.5.5.5.html\">Eric Hospital (Implementer) (OID:5.5.5.5\u00a0(use:\u00a0official))</a></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Other Id (see the one above)\">Other Id:</td><td colspan=\"3\">Assigning Authority ID/urn:oid:1.2.840.114350.1.13.435.2.7.3.688884.100\u00a0(use:\u00a0official)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"When the Transaction extension is set to FHIR REST, this extension specifies which implementation guides and CapabilityStatement resources this Endpoint conforms to. If an Endpoint conforms to multiple versions of a single IG (i.e. multiple versions of US Core) then multiple instances of this extension should be specified.\">FHIR IG Conformance:</td><td colspan=\"3\"><ul><li>igCanonicalUrl: <a href=\"http://hl7.org/fhir/us/core/STU6.1/ImplementationGuide-hl7.fhir.us.core.html\">US Core Implementation Guide</a></li><li>igPackage: <a href=\"http://example.org/fhir/us/core/STU6.1\">http://example.org/fhir/us/core/STU6.1</a></li><li>igVersion: 6.1.0</li><li>capStmt: <a href=\"http://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-server.html\">http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server</a></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension is used on the Endpoint resource and indicates expected future down-time of the endpoint for maintenance, etc.\"><a href=\"StructureDefinition-Downtime.html\">Downtime</a></td><td colspan=\"3\">Once per 1 week</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension indicates the profile/standard supported for transactions sent to the Endpoint address (e.g., XCA ITI-38). When this extension appears on an Organization, it represents initiating transactions. When this extension appears on an Endpoint, it identifies responding transactions.\"><a href=\"StructureDefinition-Transaction.html\">Transaction</a></td><td colspan=\"3\"><span title=\"Codes:{https://sequoiaproject.org/fhir/sphd/CodeSystem/TransactionCodes FHIR REST}\">FHIR REST</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension is used on both the Endpoint and Organization resources.\nFor an Endpoint, this extension defines the Purpose(s) of Use for which the Endpoint will receive and respond to requests from others. An Organization may have multiple Endpoints for the same Transaction type that receive and process different Purposes of Use.\nFor an Organization, this extension defines the Purpose(s) of Use for which the Organization will initiate requests to others.\"><a href=\"StructureDefinition-PurposesOfUse.html\">Purposes Of Use</a></td><td colspan=\"3\"><span title=\"Codes:{http://healthit.gov/nhin/purposeofuse TREATMENT}\">Treatment</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Defines the Endpoint timeout (seconds) for the transaction type.\"><a href=\"StructureDefinition-Timeout.html\">Timeout</a></td><td colspan=\"3\">30 minutes<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM codemin = 'min')</span></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"When an implementation of the Sequoia Directory IG allows multiple published versions of a single transaction profile/standard, this extension indicates the specific Version supported for transactions sent to the Endpoint address. If the transaction is "FHIR REST" then this should represent the FHIR version supported by the Endpoint.\"><a href=\"StructureDefinition-Version.html\">Version</a></td><td colspan=\"3\">4.0.1</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension uses AuditEvent resource to capture the date changed (last updated) value in date format with option for description text, such as reason for change.\"><a href=\"StructureDefinition-LastUpdate.html\">Last Update</a></td><td colspan=\"3\"><a href=\"#hcfhir-endpoint/Inline-example-update\">AuditEvent: type = Restful Operation (Audit Event ID#rest); subtype = update (FHIR Restful Interactions#update); action = U; recorded = 2013-06-20 23:41:23+0000; outcome = 0</a></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension indicates the Individual Access Services (IAS) Response Mode(s) supported by the endpoint.\"><a href=\"StructureDefinition-IASResponseMode.html\">IAS Response Mode</a></td><td colspan=\"3\"><a href=\"CodeSystem-IASResponseModeCS.html#IASResponseModeCS-mode1\">IAS Response Mode Codes: mode1</a> (Mode 1)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension indicates whether an Endpoint is a responding node or\u00a0a passthrough node.\"><a href=\"StructureDefinition-EndpointType.html\">EndpointType</a></td><td colspan=\"3\"><a href=\"CodeSystem-EndpointType.html#EndpointType-responding-node\">Endpoint Type: responding-node</a> (Responding Node)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension is used on the Endpoint resource and provides SNOMED CT codes to indicate the clinical role(s) of document authors for documents available from that Endpoint.\"><a href=\"StructureDefinition-Roles.html\">Roles</a></td><td colspan=\"3\"><span title=\"Codes:{http://snomed.info/sct 309343006}\">Physician</span></td></tr></table><hr/><p><b>Contained Resource</b></p><hr/><a name=\"fhir-endpoint/Inline-example-update\"> </a><p class=\"res-header-id\"><b>AuditEvent #Inline-example-update</b></p><a name=\"hcfhir-endpoint/Inline-example-update\"> </a><p><b>type</b>: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-audit-event-type.html#audit-event-type-rest\">Audit Event ID: rest</a> (Restful Operation)</p><p><b>subtype</b>: <a href=\"http://hl7.org/fhir/R4/codesystem-restful-interaction.html#restful-interaction-update\">FHIR Restful Interactions: update</a> (update)</p><p><b>action</b>: Update</p><p><b>recorded</b>: 2013-06-20 23:41:23+0000</p><p><b>outcome</b>: Success</p><blockquote><p><b>agent</b></p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/extra-security-role-type humanuser}\">human user</span></p><p><b>who</b>: Identifier: 95</p><p><b>altId</b>: 601847123</p><p><b>name</b>: Grahame Grieve</p><p><b>requestor</b>: true</p><h3>Networks</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Address</b></td><td><b>Type</b></td></tr><tr><td style=\"display: none\">*</td><td>127.0.0.1</td><td>IP Address</td></tr></table></blockquote><h3>Sources</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Site</b></td><td><b>Observer</b></td><td><b>Type</b></td></tr><tr><td style=\"display: none\">*</td><td>Cloud</td><td>Identifier: hl7connect.healthintersections.com.au</td><td><a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-security-source-type.html#security-source-type-3\">Audit Event Source Type: 3</a> (Web Server)</td></tr></table></div>"
},
"contained" : [
{
"resourceType" : "AuditEvent",
"id" : "Inline-example-update",
"type" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
"code" : "rest",
"display" : "Restful Operation"
},
"subtype" : [
{
"system" : "http://hl7.org/fhir/restful-interaction",
"code" : "update",
"display" : "update"
}
],
"action" : "U",
"recorded" : "2013-06-20T23:41:23Z",
"outcome" : "0",
"agent" : [
{
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
"code" : "humanuser",
"display" : "human user"
}
]
},
"who" : {
"identifier" : {
"value" : "95"
}
},
"altId" : "601847123",
"name" : "Grahame Grieve",
"requestor" : true,
"network" : {
"address" : "127.0.0.1",
"type" : "2"
}
}
],
"source" : {
"site" : "Cloud",
"observer" : {
"identifier" : {
"value" : "hl7connect.healthintersections.com.au"
}
},
"type" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/security-source-type",
"code" : "3",
"display" : "Web Server"
}
]
}
}
],
"extension" : [
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/TransactionCodes",
"code" : "FHIR REST"
}
]
}
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout",
"valueDuration" : {
"value" : 30,
"unit" : "minutes",
"system" : "http://unitsofmeasure.org",
"code" : "min"
}
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version",
"valueString" : "4.0.1"
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://healthit.gov/nhin/purposeofuse",
"code" : "TREATMENT"
}
]
}
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "309343006",
"display" : "Physician"
}
]
}
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime",
"valueTiming" : {
"repeat" : {
"period" : 1,
"periodUnit" : "wk"
}
}
},
{
"extension" : [
{
"url" : "igCanonicalUrl",
"valueCanonical" : "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
},
{
"url" : "igPackage",
"valueUrl" : "http://example.org/fhir/us/core/STU6.1"
},
{
"url" : "igVersion",
"valueString" : "6.1.0"
},
{
"url" : "capStmt",
"valueUrl" : "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"
}
],
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance"
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate",
"valueReference" : {
"reference" : "#Inline-example-update"
}
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType",
"valueCoding" : {
"system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/EndpointType",
"code" : "responding-node"
}
},
{
"url" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode",
"valueCoding" : {
"system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/IASResponseModeCS",
"code" : "mode1"
}
}
],
"identifier" : [
{
"use" : "official",
"type" : {
"coding" : [
{
"system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
"code" : "HCID"
}
]
},
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:1.2.840.114350.1.13.435.2.7.3.688884.100"
},
{
"use" : "official",
"type" : {
"coding" : [
{
"system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
"code" : "AAID"
}
]
},
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:1.2.840.114350.1.13.435.2.7.3.688884.100"
}
],
"status" : "active",
"connectionType" : {
"system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code" : "hl7-fhir-rest"
},
"name" : "patient query",
"managingOrganization" : {
🔗 "reference" : "Organization/5.5.5.5"
},
"payloadType" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code" : "NI"
}
]
}
],
"address" : "https://example.org/fhir"
}