Videolenke

API-et gir videoløsninger mulighet til å administrere videolenke med tilhørende metadata på vegne av en helseorganisasjon.

API-et følger HL7 FHIR-standard (R4 med R6 extension for VirtualService) og sendes over REST.

Funksjonalitet:

Opprette videolenke med valgfri metadata (periode, brukerveiledning)
Oppdatere eller avslutte gyldighetsperiode for eksisterende lenke
Hente informasjon om registrert videolenke
Hver helseorganisasjon kan kun ha én aktiv videolenke om gangen.

API-navn	Videolenke
Funksjonelt område	Timeavtaler
API-versjon og dato publisert	0.9 Dec 4, 2025
Status	Utvikling
API-dokumentasjon sist endret	Dec 4, 2025
Teknologi	REST, FHIR

Metoder

Operasjon	URL	Beskrivelse

Operasjon	URL	Beskrivelse
POST	`[base]/Location?managing-organization.identifier=urn:oid:2.16.578.1.12.4.1.2`	Opprett videolenke
GET	`[base]/Location?managing-organization.identifier=urn:oid:2.16.578.1.12.4.1.2/8137991`	Hent videloenke basert på orgnummer
PUT	`[base]/Location?managing-organization.identifier=urn:oid:2.16.578.1.12.4.1.2/8137991`	Oppdater videlenke

Dataelementer og obligatoriske krav

Element	FHIR-path	Beskrivelse	Obligatorisk

Element

FHIR-path

Beskrivelse

Obligatorisk

HER-id til kommunikasjonspart

<managingOrganization>
   <identifier>
      <system value="urn:oid:2.16.578.1.12.4.1.2" />
      <value value="8137991" />
   </identifier>
</managingOrganization>

Skal peke til en unik HERID i Adresseregisteret.
Skal være HERID til kommunikasjonspart (dvs. HERID nivå 2 i Adresseregistret).

Ja

Url til videoløsning

<extension url="virtualAddress">
      <valueUrl value=https://teams.microsoft.com/l/meetup-join/19%3ameeting_example123/>
</extension>

URL til videoløsning

Ja

Gyldighetsperiode

<extension url=http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod>
    <valuePeriod>
      <start value="2025-10-01"/>
      <end value="2026-10-01"/>
    </valuePeriod>
  </extension>

Startdato for lenkens gyldighet. Dersom startdato ikke oppgis vil dagens dato brukes som default

Sluttdato for lenkens gyldighet. Dersom startdato ikke oppgis vil dagens dato + 100 år brukes som default

Nei

Typiske feilsituasjoner og responser

Scenario	HTTP-status	FHIR-respons (OperationOutcome)

Scenario	HTTP-status	FHIR-respons (OperationOutcome)
Ugyldig orgnummer eller token	`401 Unauthorized`	OperationOutcome med detaljer om autentisering
Manglende obligatoriske felter (f.eks. URL)	`400 Bad Request`	OperationOutcome med issue: `required element missing`
Ressurs ikke funnet (GET/PUT)	`404 Not Found`	OperationOutcome med issue: `resource not found`
Konflikt (f.eks. duplikat ved POST)	`409 Conflict`	OperationOutcome med issue: `duplicate resource`
Intern feil	`500 Internal Server Error`	OperationOutcome med issue: `server error`

POST – Opprett videolenke

URL: [base]/Location?managing-organization.identifier=urn:oid:2.16.578.1.12.4.1.2
Beskrivelse: Opprett en ny videolenke med metadata.

Request (XML):

<Location xmlns=http://hl7.org/fhir>
  <managingOrganization>
    <identifier>
      <system value="urn:oid:2.16.578.1.12.4.1.2"/>
      <value value="8135429"/>
    </identifier>
  </managingOrganization>
  <extension url="http://hl7.no/fhir/StructureDefinition/no-basis-virtual-service">
    <extension url="virtualAddress">
      <valueUrl value="https://teams.microsoft.com/l/meetup-join/19%3ameeting_example123/"/>
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod">
      <valuePeriod>
        <start value="2025-10-01"/>
        <end value="2026-10-01"/>
      </valuePeriod>
    </extension>
  </extension>
</Location>

Response (JSON):


{
  "status": "201 Created",
  "id": "8135429",
  "message": "videolenke opprettet"
}

GET – Hent videolenke

URL: GET [base]/Location?managing-organization.identifier=urn:oid:2.16.578.1.12.4.1.2|8137991
Beskrivelse: Hent videolenke basert på orgnummer.

Request:

GET /Organization/8135429

Response (JSON):


{
  "resourceType": "Location",
  "managingOrganization": {
    "identifier": {
      "system": "urn:oid:2.16.578.1.12.4.1.2",
      "value": "8135429"
    }
  },
  "extension": [
    {
      "url": "virtualAddress",
      "valueUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_example123/"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod",
      "valuePeriod": {
        "start": "2025-10-01",
        "end": "2026-10-01"
      }
    }
  ]
}

PUT – Oppdater videolenke

URL: [base]/Location?managing-organization.identifier=urn:oid:2.16.578.1.12.4.1.2|8137991
Beskrivelse: Oppdater eksisterende videolenke (f.eks. bytte URL eller periode) For å “slette“ en videolenke brukes denne funksjonen og slutten på perioden settes til gårsdagens dato.

Request (JSON):


<Location xmlns=http://hl7.org/fhir>
  <managingOrganization>
    <identifier>
      <system value="urn:oid:2.16.578.1.12.4.1.2"/>
      <value value="8135429"/>
    </identifier>
  </managingOrganization>
  <extension url="http://hl7.no/fhir/StructureDefinition/no-basis-virtual-service">
    <extension url="virtualAddress">
      <valueUrl value="https://teams.microsoft.com/l/meetup-join/newLink/"/>
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod">
      <valuePeriod>
        <start value="2025-10-01"/>
        <end value="2026-10-01"/>
      </valuePeriod>
    </extension>
  </extension>
</Location>

Response


{
  "status": "200 OK",
  "message": "videolenke oppdatert"
}