eHealth Infrastructure
2.5.0 - release

eHealth Infrastructure - Local Development build (v2.5.0). See the Directory of published versions

: organization - JSON Representation

Active as of 2022-10-11

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "organization",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>organization</h2><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title=\"GET a resource (read interaction)\">Read</b></th><th><b title=\"GET past versions of resources (vread interaction)\">V-Read</b></th><th><b title=\"GET all set of resources of the type (search interaction)\">Search</b></th><th><b title=\"PUT a new resource version (update interaction)\">Update</b></th><th><b title=\"PATCH a new resource version (patch interaction)\">Patch</b></th><th><b title=\"POST a new resource (create interaction)\">Create</b></th><th><b title=\"DELETE a resource (delete interaction)\">Delete</b></th></tr><tr><td>CareTeam</td><td><a href=\"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careteam\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careteam</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td>y</td></tr><tr><td>OperationDefinition</td><td><a href=\"http://hl7.org/fhir/StructureDefinition/OperationDefinition\">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td>y</td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>Organization</td><td><a href=\"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-organization\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-organization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td></td></tr><tr><td>Practitioner</td><td><a href=\"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioner\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td>y</td></tr><tr><td>PractitionerRole</td><td><a href=\"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitionerrole\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitionerrole</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td>y</td></tr></table></div>"
  },
  "url" : "http://ehealth.sundhed.dk/fhir/CapabilityStatement/organization",
  "version" : "2.5.0",
  "name" : "organization",
  "status" : "active",
  "date" : "2022-10-11T03:09:39.876+00:00",
  "publisher" : "Systematic | Trifork",
  "contact" : [
    {
      "name" : "Systematic | Trifork",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "kind" : "instance",
  "software" : {
    "name" : "organization",
    "version" : "1.10.1"
  },
  "implementation" : {
    "description" : "eHealth organization service",
    "url" : "https://organization.devtest.systematic-ehealth.com/fhir"
  },
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "xml",
    "application/fhir+json",
    "json",
    "application/x-turtle",
    "ttl",
    "html/json",
    "html/xml",
    "html/turtle"
  ],
  "rest" : [
    {
      "mode" : "server",
      "resource" : [
        {
          "type" : "CareTeam",
          "profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careteam",
          "interaction" : [
            {
              "code" : "update"
            },
            {
              "code" : "search-type"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "read"
            },
            {
              "code" : "delete"
            },
            {
              "code" : "create"
            }
          ],
          "conditionalCreate" : true,
          "conditionalUpdate" : true,
          "conditionalDelete" : "multiple",
          "searchInclude" : [
            "CareTeam:managingOrganization",
            "CareTeam:participant",
            "CareTeam:subject"
          ],
          "searchRevInclude" : [
            "CareTeam:context",
            "CareTeam:encounter",
            "CareTeam:managingOrganization",
            "CareTeam:participant",
            "CareTeam:patient",
            "CareTeam:subject",
            "Organization:endpoint",
            "Organization:partof",
            "PractitionerRole:endpoint",
            "PractitionerRole:location",
            "PractitionerRole:organization",
            "PractitionerRole:practitioner",
            "PractitionerRole:service"
          ],
          "searchParam" : [
            {
              "name" : "_content",
              "type" : "string",
              "documentation" : "Search the contents of the resource's data using a fulltext search"
            },
            {
              "name" : "_has",
              "type" : "string",
              "documentation" : "Return resources linked to by the given target"
            },
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "The ID of the resource"
            },
            {
              "name" : "_language",
              "type" : "string",
              "documentation" : "The language of the resource"
            },
            {
              "name" : "_lastUpdated",
              "type" : "date",
              "documentation" : "Only return resources which were last updated as specified by the given range"
            },
            {
              "name" : "_profile",
              "type" : "uri",
              "documentation" : "Search for resources which have the given profile"
            },
            {
              "name" : "_security",
              "type" : "token",
              "documentation" : "Search for resources which have the given security labels"
            },
            {
              "name" : "_tag",
              "type" : "token",
              "documentation" : "Search for resources which have the given tag"
            },
            {
              "name" : "_text",
              "type" : "string",
              "documentation" : "Search the contents of the resource's narrative using a fulltext search"
            },
            {
              "name" : "category",
              "type" : "token",
              "documentation" : "Type of team"
            },
            {
              "name" : "context",
              "type" : "reference",
              "documentation" : "Encounter or episode associated with CareTeam"
            },
            {
              "name" : "date",
              "type" : "date",
              "documentation" : "Time period team covers"
            },
            {
              "name" : "encounter",
              "type" : "reference",
              "documentation" : "Encounter or episode associated with CareTeam"
            },
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "External Ids for this team"
            },
            {
              "name" : "managingOrganization",
              "type" : "reference",
              "documentation" : "Managing organization of a care team"
            },
            {
              "name" : "participant",
              "type" : "reference",
              "documentation" : "Who is involved"
            },
            {
              "name" : "patient",
              "type" : "reference",
              "documentation" : "Who care team is for"
            },
            {
              "name" : "reasonCode",
              "type" : "token",
              "documentation" : "Reason care team exists"
            },
            {
              "name" : "status",
              "type" : "token",
              "documentation" : "proposed | active | suspended | inactive | entered-in-error"
            },
            {
              "name" : "subject",
              "type" : "reference",
              "documentation" : "Who care team is for"
            }
          ],
          "operation" : [
            {
              "name" : "validate",
              "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"
            }
          ]
        },
        {
          "type" : "OperationDefinition",
          "profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
          "interaction" : [
            {
              "code" : "read"
            }
          ],
          "searchInclude" : [
            "*"
          ],
          "searchRevInclude" : [
            "CareTeam:context",
            "CareTeam:encounter",
            "CareTeam:managingOrganization",
            "CareTeam:participant",
            "CareTeam:patient",
            "CareTeam:subject",
            "Organization:endpoint",
            "Organization:partof",
            "PractitionerRole:endpoint",
            "PractitionerRole:location",
            "PractitionerRole:organization",
            "PractitionerRole:practitioner",
            "PractitionerRole:service"
          ]
        },
        {
          "type" : "Organization",
          "profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-organization",
          "interaction" : [
            {
              "code" : "update"
            },
            {
              "code" : "search-type"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "read"
            },
            {
              "code" : "patch"
            },
            {
              "code" : "create"
            }
          ],
          "conditionalCreate" : true,
          "conditionalUpdate" : true,
          "searchInclude" : [
            "Organization:partof"
          ],
          "searchRevInclude" : [
            "CareTeam:managingOrganization",
            "Organization:partof"
          ],
          "searchParam" : [
            {
              "name" : "_content",
              "type" : "string",
              "documentation" : "Search the contents of the resource's data using a fulltext search"
            },
            {
              "name" : "_has",
              "type" : "string",
              "documentation" : "Return resources linked to by the given target"
            },
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "The ID of the resource"
            },
            {
              "name" : "_language",
              "type" : "string",
              "documentation" : "The language of the resource"
            },
            {
              "name" : "_lastUpdated",
              "type" : "date",
              "documentation" : "Only return resources which were last updated as specified by the given range"
            },
            {
              "name" : "_profile",
              "type" : "uri",
              "documentation" : "Search for resources which have the given profile"
            },
            {
              "name" : "_security",
              "type" : "token",
              "documentation" : "Search for resources which have the given security labels"
            },
            {
              "name" : "_tag",
              "type" : "token",
              "documentation" : "Search for resources which have the given tag"
            },
            {
              "name" : "_text",
              "type" : "string",
              "documentation" : "Search the contents of the resource's narrative using a fulltext search"
            },
            {
              "name" : "active",
              "type" : "token",
              "documentation" : "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
            },
            {
              "name" : "address",
              "type" : "string",
              "documentation" : "A (part of the) address of the organization"
            },
            {
              "name" : "address-city",
              "type" : "string",
              "documentation" : "A city specified in an address"
            },
            {
              "name" : "address-country",
              "type" : "string",
              "documentation" : "A country specified in an address"
            },
            {
              "name" : "address-postalcode",
              "type" : "string",
              "documentation" : "A postal code specified in an address"
            },
            {
              "name" : "address-state",
              "type" : "string",
              "documentation" : "A state specified in an address"
            },
            {
              "name" : "address-use",
              "type" : "token",
              "documentation" : "A use code specified in an address"
            },
            {
              "name" : "contactName",
              "type" : "string",
              "documentation" : "Contact name"
            },
            {
              "name" : "cvrNumber",
              "type" : "string",
              "documentation" : "Cvr number of the organization"
            },
            {
              "name" : "endpoint",
              "type" : "reference",
              "documentation" : "Technical endpoints providing access to services operated for the organization"
            },
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "Any identifier for the organization (not the accreditation issuer's identifier)"
            },
            {
              "name" : "municipalityCode",
              "type" : "string",
              "documentation" : "Municipality code of the organization"
            },
            {
              "name" : "name",
              "type" : "string",
              "documentation" : "A portion of the organization's name or alias"
            },
            {
              "name" : "partof",
              "type" : "reference",
              "documentation" : "An organization of which this organization forms a part"
            },
            {
              "name" : "phonetic",
              "type" : "string",
              "documentation" : "A portion of the organization's name using some kind of phonetic matching algorithm"
            },
            {
              "name" : "providerIdentifier",
              "type" : "string",
              "documentation" : "Provider identifier of the organization"
            },
            {
              "name" : "regionCode",
              "type" : "string",
              "documentation" : "Region code of the organization"
            },
            {
              "name" : "source",
              "type" : "token",
              "documentation" : "Source of the organization"
            },
            {
              "name" : "specialty",
              "type" : "token",
              "documentation" : "Specialty of the organization"
            },
            {
              "name" : "type",
              "type" : "token",
              "documentation" : "A code for the type of organization"
            }
          ],
          "operation" : [
            {
              "name" : "validate",
              "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"
            },
            {
              "name" : "traverse-to-sor",
              "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/Organization-i-traverse-to-sor",
              "documentation" : "Traverse upforwards to the first SOR organization\nHttp response code 404 will be returned if no related SOR organization could be found"
            }
          ]
        },
        {
          "type" : "Practitioner",
          "profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioner",
          "interaction" : [
            {
              "code" : "update"
            },
            {
              "code" : "search-type"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "read"
            },
            {
              "code" : "delete"
            },
            {
              "code" : "create"
            }
          ],
          "conditionalCreate" : true,
          "conditionalUpdate" : true,
          "conditionalDelete" : "multiple",
          "searchInclude" : [
            "*"
          ],
          "searchRevInclude" : [
            "CareTeam:context",
            "CareTeam:encounter",
            "CareTeam:managingOrganization",
            "CareTeam:participant",
            "CareTeam:patient",
            "CareTeam:subject",
            "Organization:endpoint",
            "Organization:partof",
            "PractitionerRole:endpoint",
            "PractitionerRole:location",
            "PractitionerRole:organization",
            "PractitionerRole:practitioner",
            "PractitionerRole:service"
          ],
          "searchParam" : [
            {
              "name" : "_content",
              "type" : "string",
              "documentation" : "Search the contents of the resource's data using a fulltext search"
            },
            {
              "name" : "_has",
              "type" : "string",
              "documentation" : "Return resources linked to by the given target"
            },
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "The ID of the resource"
            },
            {
              "name" : "_language",
              "type" : "string",
              "documentation" : "The language of the resource"
            },
            {
              "name" : "_lastUpdated",
              "type" : "date",
              "documentation" : "Only return resources which were last updated as specified by the given range"
            },
            {
              "name" : "_profile",
              "type" : "uri",
              "documentation" : "Search for resources which have the given profile"
            },
            {
              "name" : "_security",
              "type" : "token",
              "documentation" : "Search for resources which have the given security labels"
            },
            {
              "name" : "_tag",
              "type" : "token",
              "documentation" : "Search for resources which have the given tag"
            },
            {
              "name" : "_text",
              "type" : "string",
              "documentation" : "Search the contents of the resource's narrative using a fulltext search"
            },
            {
              "name" : "active",
              "type" : "token",
              "documentation" : "Whether the practitioner record is active"
            },
            {
              "name" : "address",
              "type" : "string",
              "documentation" : "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
            },
            {
              "name" : "address-city",
              "type" : "string",
              "documentation" : "A city specified in an address"
            },
            {
              "name" : "address-country",
              "type" : "string",
              "documentation" : "A country specified in an address"
            },
            {
              "name" : "address-postalcode",
              "type" : "string",
              "documentation" : "A postalCode specified in an address"
            },
            {
              "name" : "address-state",
              "type" : "string",
              "documentation" : "A state specified in an address"
            },
            {
              "name" : "address-use",
              "type" : "token",
              "documentation" : "A use code specified in an address"
            },
            {
              "name" : "communication",
              "type" : "token",
              "documentation" : "One of the languages that the practitioner can communicate with"
            },
            {
              "name" : "email",
              "type" : "token",
              "documentation" : "A value in an email contact"
            },
            {
              "name" : "family",
              "type" : "string",
              "documentation" : "A portion of the family name"
            },
            {
              "name" : "gender",
              "type" : "token",
              "documentation" : "Gender of the practitioner"
            },
            {
              "name" : "given",
              "type" : "string",
              "documentation" : "A portion of the given name"
            },
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "A practitioner's Identifier"
            },
            {
              "name" : "name",
              "type" : "string",
              "documentation" : "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
            },
            {
              "name" : "phone",
              "type" : "token",
              "documentation" : "A value in a phone contact"
            },
            {
              "name" : "phonetic",
              "type" : "string",
              "documentation" : "A portion of either family or given name using some kind of phonetic matching algorithm"
            },
            {
              "name" : "telecom",
              "type" : "token",
              "documentation" : "The value in any kind of contact"
            }
          ],
          "operation" : [
            {
              "name" : "validate",
              "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"
            }
          ]
        },
        {
          "type" : "PractitionerRole",
          "profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitionerrole",
          "interaction" : [
            {
              "code" : "update"
            },
            {
              "code" : "search-type"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "read"
            },
            {
              "code" : "delete"
            },
            {
              "code" : "create"
            }
          ],
          "conditionalCreate" : true,
          "conditionalUpdate" : true,
          "conditionalDelete" : "multiple",
          "searchInclude" : [
            "*",
            "PractitionerRole:endpoint",
            "PractitionerRole:location",
            "PractitionerRole:organization",
            "PractitionerRole:practitioner",
            "PractitionerRole:service"
          ],
          "searchRevInclude" : [
            "CareTeam:context",
            "CareTeam:encounter",
            "CareTeam:managingOrganization",
            "CareTeam:participant",
            "CareTeam:patient",
            "CareTeam:subject",
            "Organization:endpoint",
            "Organization:partof",
            "PractitionerRole:endpoint",
            "PractitionerRole:location",
            "PractitionerRole:organization",
            "PractitionerRole:practitioner",
            "PractitionerRole:service"
          ],
          "searchParam" : [
            {
              "name" : "_content",
              "type" : "string",
              "documentation" : "Search the contents of the resource's data using a fulltext search"
            },
            {
              "name" : "_has",
              "type" : "string",
              "documentation" : "Return resources linked to by the given target"
            },
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "The ID of the resource"
            },
            {
              "name" : "_language",
              "type" : "string",
              "documentation" : "The language of the resource"
            },
            {
              "name" : "_lastUpdated",
              "type" : "date",
              "documentation" : "Only return resources which were last updated as specified by the given range"
            },
            {
              "name" : "_profile",
              "type" : "uri",
              "documentation" : "Search for resources which have the given profile"
            },
            {
              "name" : "_security",
              "type" : "token",
              "documentation" : "Search for resources which have the given security labels"
            },
            {
              "name" : "_tag",
              "type" : "token",
              "documentation" : "Search for resources which have the given tag"
            },
            {
              "name" : "_text",
              "type" : "string",
              "documentation" : "Search the contents of the resource's narrative using a fulltext search"
            },
            {
              "name" : "active",
              "type" : "token",
              "documentation" : "Whether this practitioner's record is in active use"
            },
            {
              "name" : "date",
              "type" : "date",
              "documentation" : "The period during which the practitioner is authorized to perform in these role(s)"
            },
            {
              "name" : "email",
              "type" : "token",
              "documentation" : "A value in an email contact"
            },
            {
              "name" : "endpoint",
              "type" : "reference",
              "documentation" : "Technical endpoints providing access to services operated for the practitioner with this role"
            },
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "A practitioner's Identifier"
            },
            {
              "name" : "location",
              "type" : "reference",
              "documentation" : "One of the locations at which this practitioner provides care"
            },
            {
              "name" : "organization",
              "type" : "reference",
              "documentation" : "The identity of the organization the practitioner represents / acts on behalf of"
            },
            {
              "name" : "phone",
              "type" : "token",
              "documentation" : "A value in a phone contact"
            },
            {
              "name" : "practitioner",
              "type" : "reference",
              "documentation" : "Practitioner that is able to provide the defined services for the organation"
            },
            {
              "name" : "role",
              "type" : "token",
              "documentation" : "The practitioner can perform this role at for the organization"
            },
            {
              "name" : "service",
              "type" : "reference",
              "documentation" : "The list of healthcare services that this worker provides for this role's Organization/Location(s)"
            },
            {
              "name" : "specialty",
              "type" : "token",
              "documentation" : "The practitioner has this specialty at an organization"
            },
            {
              "name" : "telecom",
              "type" : "token",
              "documentation" : "The value in any kind of contact"
            }
          ],
          "operation" : [
            {
              "name" : "validate",
              "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"
            }
          ]
        }
      ],
      "interaction" : [
        {
          "code" : "transaction"
        },
        {
          "code" : "history-system"
        }
      ],
      "operation" : [
        {
          "name" : "persist-login",
          "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-persist-login",
          "documentation" : "This operation persists login information into CareTeams and PractitionerRoles\nThe following elements of each careteam are mandatory:\n- id: Reference based on the careteam from the saml security token\n- status: any\n- name: any\n- reasonCode: any\n- participant: 1 for each careteam-role in the saml security token\n-- role: from the saml security token\n-- member: reference to the practitioner\n-- onBehalfOf: reference to organization (cannot be set currently because of a bug in hapi)\n\nPersist-login will find each careteam, and update it with any new participants and roles from the input bundle.\nThe input careteam resources are are used as a container for the participant list. The rest of the fields are not used.\nThe following elements of each PractitionerRole are mandatory:\n- practitioner\n- organization\n- code: roles from the saml security token (CareteamParticipantRole valueset)\n\nPersist-login will search for practitionerRoles for each combination of (practitioner, organization) and create it if it doesn't already exists."
        },
        {
          "name" : "import-organizations",
          "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-import-organizations",
          "documentation" : "Import a bundle containing at least one organization tree."
        },
        {
          "name" : "reindex-terminology",
          "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-reindex-terminology"
        },
        {
          "name" : "process-message",
          "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-process-message",
          "documentation" : "Accept a FHIR Message Bundle for processing"
        },
        {
          "name" : "perform-reindexing-pass",
          "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-perform-reindexing-pass",
          "documentation" : "Forces a single pass of the resource reindexing processor"
        },
        {
          "name" : "meta",
          "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-meta"
        },
        {
          "name" : "get-resource-counts",
          "definition" : "https://organization.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-get-resource-counts",
          "documentation" : "Provides the number of resources currently stored on the server, broken down by resource type"
        }
      ]
    }
  ]
}