Introduktion til Pharmo API

Vi introducerer nu muligheden for at sende recepter via dit eksisterende dyrlæge IT-system/journalsystem.

Send recepter via dit eksisterende IT-system, dermed når recepten lovligt frem til apoteket.
Det kræver naturligvis at din IT-leverandør understøtter denne løsning.

Information til IT-leverandører

Vi har udviklet et API, der gør det muligt for den enkelte praksis-bruger at sende recepter fra jeres IT-system til det lokale apotek via Pharmo.

Med vores landsdækkende netværk af apoteker, kan vi sikkert formidle jeres recepter til apoteket.

API-kald:

Adgang til at hente og sende data

  • Den enkelte bruger kan med sit eksisterende login til pharmo og IT-leverandørens klient-information generere en access-token.
    Se afsnittet vedr. oprettelse af access-token til praksis
  • Jeres praksisser skal have jer registreret som IT-leverandør i Pharmo for at kunne anvende API'et.
    Send en mail til info@pharmo.dk med den/de praksisser, som skal knyttes til jer som leverandør.

Opret access- og refresh token til praksis bruger

Klienten oprettes til den enkelte IT-leverandør.

Med klientoplysninger og den enkelte brugeres login til pharmo.dk oprettes en token [access_token]. Den genererede token er knyttet til den enkelte bruger og giver adgang til brugerens oplysninger og praksis. Skriv til info@pharmo.dk, så hjælper vi med den praktiske opsætning.

POST-request til:
https://pharmo.dk/oauth/token

Medsend følgende form-data:

key: client_id
value: (id'et for den specifikke klient oprettet af den enkelte bruger)
key: client_secret
value: (kode genereret til den specifikke klient oprettet af den enkelte bruger)
key: grant_type
value: "password"
key: username
value: (brugernavnet for den pågældende bruger)
key: password
value: (adgangskoden for den pågældende bruger)
  • Se eksempel på returneret data 
    //Returneret data
    
       {
        "token_type": "Bearer",
        "expires_in": 31536000,
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbm0o_TVB42cOtIkBwHv...",
        "refresh_token": "def5020090aa5392da2e5a709774c4747c8fa544e..."
        }

Forny tidligere oprettet access token

En token udløber efter 1 år. Det er muligt at generere en ny token ved brug af den gamle med følgende kald.

POST-request til:
https://pharmo.dk/oauth/token

Medsend følgende form-data:

key: client_id
value: (id'et for den specifikke klient oprettet af den enkelte bruger)
key: client_secret
value: (kode genereret til den specifikke klient oprettet af den enkelte bruger)
key: grant_type
value: "refresh_token"
key: refresh_token
value: (den refresh_token som blev genereret og returneret ved seneste oprettelse/fornyelse)
  • Se eksempel på returneret data 
    //Returneret data
    
       {
           'token_type': 'Bearer',
            'expires_in': 31536000,
            'access_token': 'eyJ0eXAiOiJKV1QiLCJhbm0o_TVB42cOtIkBwHv...',
            'refresh_token': 'def5020090aa5392da2e5a709774c4747c8fa544e...'
        }
     
    // Som det fremgår af de returnerede data, er en token aktiv 1 år (31.536.000 sekunder).

Opret Access token til den enkelte praksis bruger

Vi anbefaler Postman til at generere en access_token til prakis via GET-request. Du kan også blot anvende din browser.

GET-request til:
https://pharmo.dk/api/v1/user/request-access-token

Medsend følgende form-data:

key: email
value: -den emailadresse praksis bruger til login på pharmo.dk -
key: password
value: - Adgangskoden som anvendes til login på pharmo.dk - 
										
//Returneret data for pågældende bruger


	{
		"access_token":"eyJ0eXAiOiJKVg3yPRY1qEdE-Y9LuPI55AMTZol-3YPcSrLlDq7LUEtF27Bu0M....",
		"user":{"id":1,"name":"Testbruger","email":"info@pharmo.dk"}
	}

Oprettelse af en klient til IT-leverandøren

For at få adgang til den enkelte praksis skal I opsættes om IT-udbyder på jeres prakssier. Dernæst skal der oprettes en klient, der giver jeg mulighed for at oprette access tokens til jeres dyrlæger.

Send en mail til info@pharmo.dk med ønsket om at blive oprettet, så sender vi information retur og hjælper gerne med de indledende øvelser. Medsend en liste med praksisnavn og praksisnr., for de klinikker som skal opsættes med denne løsning.

Hent data fra Pharmo API via GET-requests

Hent alle IT-leverandørens praksisser

GET-request til:
https://pharmo.dk/api/v1/supplier/practices
Dette kald kan foretages direkte i din browser.
  • Se eksempel på returneret data 
    //Returneret data
    
         {
         "id": 1,
            "name": "System praksis",
            "address": "Ellebæk 17",
            "postal_code": 9400,
            "city": "Nørresundby",
            "phone": "12345678",
            "email": "support@vetpharm.dk"
        },
        {
            "id": 2,
            "name": "Test Dyreklinik",
            "address": "Dyrebakken 19",
            "postal_code": 9000,
            "city": "Aalborg",
            "phone": "12345678",
            "email": "test@dyrebakken.dk"
        },
        {...}

Hent stamdata for specifik praksis

GET-request til:
https://pharmo.dk/api/v1/practices/{id}
Dette kald kan foretages direkte i din browser.
  • Se eksempel på returneret data 
    //Returneret data
    
        {
            "id": 1,
            "name": "System praksis",
            "address": "Ellebæk 174",
            "postal_code": 9400,
            "city": "Nørresundby",
            "phone": "12345678",
            "email": "support@vetpharm.dk"
        }

Hent liste over Pharmos forhandlere/apoteker

GET-request til:
https://pharmo.dk/api/v1/dealers
Dette kald kan foretages direkte i din browser.
  • Se eksempel på returneret data 
    //Returneret data
    
          [
            {
                "id": 1,
                "name": "Fjerritslev Apotek",
                "address": "Østergade 11",
                "postal_code": "9690",
                "city": "Fjerritslev",
                "phone": "98211633",
                "email": "fjerritslev@apotekeren.dk"
            },

            {
            "id": 40,
            "name": "Systemforhandler",
            "address": "Nytorv 3,3 TV.",
            "postal_code": "9000",
            "city": "Aalborg",
            "phone": "60631409",
            "email": "info@pharmo.dk"
            },
            {...}
        ]

Hent stamdata for enkelt forhandler/apoteker

GET-request til:
https://pharmo.dk/api/v1/dealers/{id}
(access_token placeres i headeren)
{id} erstattes med et id for den pågældende forhandler/apotek.
Dette kald kan foretages direkte i din browser.
  • Se eksempel på returneret data 
    //Returneret data
    
     {
         "id": 40,
         "name": "Systemforhandler",
         "address": "Nytorv 3,3 TV.",
         "postal_code": "9000",
         "city": "Aalborg",
         "phone": "60631409",
         "email": "info@pharmo.dk"
     }

Pharmo Api-kald med påkrævet token

Nedenstående kald kan ikke foretages direkte fra browseren, idet access_token skal placeres i headeren af hver forespørgsel.

Vi anbefaler Postman til indledende tests. Placer brugerens access_token i headeren.

Hent praksissens privat kunder

GET-request til:
https://pharmo.dk/api/v1/practice/private-customers
(access_token placeres i headeren)
I headeren angives:
key: Authorization
value: Bearer <-indsæt den genererede access_token->
key: Content-Type
value: application/json
  • Se eksempel på returneret data 
    //Returneret data
    
       [
			{"id":516,"name":"Niels Petersen","address":"Solmarken 10, st","postal_code":4600,"city":"K\u00f8ge","phone":"12345678","email":null},
			{"id":517,"name":"Lauritz Jensen","address":"Solmarken 12","postal_code":4600,"city":"K\u00f8ge","phone":"12345677","email":"lj@solmarken.dk"},
			{"id":520,"name":"Lena Sørensen","address":"Solmarken 16","postal_code":4600,"city":"K\u00f8ge","phone":"12345677","email":"ls@solmarken.dk"},
		]
     
    // listen indeholder alle privatkunder der er tilknyttet denne brugers praksis. Format: Objekter i Array.

Hent datasæt med ordinationsdata

Disse data bruges til at opbygge recepten og bør hentes hver gang en ordination foretages.

For overblik over hvordan disse data anvendes, kan man med fordel bruge receptværktøjet på pharmo.dk som reference.

Her ses et billede af receptværktøjet, med referencer til de enkelte felter.

Recept eksempel

Tryk på de sorte cirkler på billedet og se hvilke data der indlæses i de enkelte felter.

Dyrearter [animals]

Dyrearterne er struktureret i grupper. F.eks.:
  • Kæledyr
  • Svin
  • Kvæg

I hver af disse grupper findes et eller flere dyr.

Dyregrupper [animal_groups]

Array med objekter. Indeholder en liste over de forskellige dyregrupper. Et produkt kan være godkendt til én eller flere grupper.

Indikationer [indications]

Array med objekter. Indeholder en liste over de forskellige indikationer.

Doseringsenheder [dose_units]

Array med objekter. Indeholder en liste over de forskellige doseringsenheder.

Doseringsfaktorer [dose_factors]

Array med objekter. Indeholder en liste over de forskellige doseringsfaktorer.

Indgivelsesmetoder [administration_routes]

Array med objekter. Indeholder en liste over de forskellige indgivelsesmetoder.

Hyppighedsenheder [frequenzy_units]

Array med objekter. Indeholder en liste over de forskellige hyppighedsenheder.

Varighedsenheder [duration_units]

Array med objekter. Indeholder en liste over de forskellige varighedsenheder.

Karantæneenheder [quarantine_units]

Array med objekter. Indeholder en liste over de forskellige karantæneenheder.

Udleveringsenheder [use_frequenzy_units]

Array med objekter. Indeholder en liste over enheder til udlevering.

Følgende data returneres:

  • Dyregrupper: [animal_groups]
    De forskellige dyregrupper som et produkt kan sælges til.
  • Dyr: [animals]
    Dyr som medicinen skal ordineres til.
  • Indikationer: [indications]
    Indikationer som medicinen skal virke mod.
  • Doseringsenheder: [dose_units]
    Enheder som anvendes ifm. dosering.
  • Doseringsfaktorer: [dose_factors]
    Enheder som anvendes ifm. doseringsfaktor.
  • Hyppighedsenheder: [frequenzy_units]
    Enheder som anvendes ifm. hvor hyppigt medicinen skal indtages.
  • Varighedsenheder: [duration_units]
    Enheder som anvendes ifm. angivelse af ordinationens varighed.
  • Indgivelsesformer: [administration_routes]
    Angiver hvordan medicinen skal indtages.
  • Karantæne enheder: [quarantine_units]
    Enheder som anvendes i forbindelse med slagtefrist og malkefrist.
  • Dyrearter: [species]
    Overornede artsangivelser. Relation mellem Dyr og Dyrearter. [species_id]
  • Dyrealdre: [ages]
    Aldersangivelser. Relation mellem Dyr og Dyrealdre. [age_id]
  • Ordinationsgrupper: [prescription_groups]
    Ordinationsgrupper. Relation mellem Indikationer og Ordinationsgrupper. [prescription_group_id]
GET-request til:
https://pharmo.dk/api/v1/prescriptions/data
I headeren angives:
key: Authorization
value: Bearer <-indsæt den genererede access_token->
key: Content-Type
value: application/json
  • Se eksempel på returneret data 
    //Returneret data
    
       {

            "animal_groups": [
                {
                    "id": 1,
                    "name": "Produktionsdyr"
                }, (...)

            "animals": [

                {
                "group": "Kæledyr",
                "animals": [
                    {
                        "id": 45,
                        "name": "hund",
                        "name_plural": "hunde",
                        "default_plural": 0,
                        "description": null,
                        "species_id": 90,
                        "age_id": 0,
                        "general": 0,
                        "slaughter": null,
                        "dairy": null,
                        "sortorder": 1,
                        "searchtags": []
                    }, (...)

                }, (...)

            ],

          "indications": [

                {
                    "id": 113,
                    "name": "blærebetændelse",
                    "prescription_group_id": 10
                }, (...)
            ]

            "dose_units": [

                {
                    "id": 1,
                    "name": "ml",
                    "name_plural": "ml"
                }, (...)

            ],

            "dose_factors": [

                {
                    "id": 1,
                    "name": "kg. dyr"
                }, (...)

            ],

            "frequenzy_units": [

                {
                    "id": 1,
                    "name": "dag",
                    "name_plural": "dage",
                    "name_each": "dagligt"
                }, (...)

            ],

            "duration_units": [

                {
                    "id": 1,
                    "name": "dag",
                    "name_plural": "dage"
                }, (...)

            ],

            "administration_routes": [

                {
                    "id": 1,
                    "name": "i musklen",
                    "code": "im"
                },
            ],

            "quarantine_units": [

                {
                    "id": 1,
                    "name": "døgn"
                }, (...)

            ],

                   "species": [

                {
                    "id": 1,
                    "name": "Svin",
                    "slaughter": 1,
                    "dairy": 0
                },

            ],

            "ages": [

                {
                    "id": 1,
                    "master_id": 55,
                    "name": "Polte, avlsdyr, pattegrise",
                    "species_id": 15
                }, (...)

            ],

            "use_frequenzy_units": [

                {
                    "id": 1,
                    "name": "dag",
                    "name_plural": "dage"
                }, (...)

            ],

            "quicknotes": [
                {
                    "id": 1,
                    "text": "Dosis jævnfør vejledning i besætnings diagnose",
                    "category": "Vejledning"
                }, (...)
            ]
        }

Send Privat recept via Pharmo API

Dette endpoint anvendes til recepter for privatkunder.

Identifikation via fremmednøgle

Du kan udfylde felet foreign_key og dermed anvende din egen kundenøgle til identifikation af kunden.

Når feltet er udfyldt, tjekker Pharmo API om en kunde med denne nøgle eksisterer for den pågældende praksis. I skal altid sende alle kundedata i forbindelse med recepten, så vil kunden på Pharmo blive opdateret med jeres seneste oplysninger

Ved test kan du med fordel bruge dealer_id = 40, dermed sendes recepten til en testforhandler.

Opsæt en test i Postman, dermed kan API'et afprøves inden den faktiske integration.

POST-request til:
https://pharmo.dk/api/v1/prescriptions/private
I headeren angives:
key: Authorization
value: Bearer <-indsæt den genererede access_token->
Token til identifikation af dyrlæge/bruger på Pharmo. Hvis en praksis har flere brugere, skal der anvendes en unik token for hver bruger.
key: Content-Type
value: application/json

Medsend følgende form-data:

key: foreign_key
value: (String)
Valgfri
IT-leverandørens egen reference til recepten.
key: dealer_id
value: (Integer)
Påkrævet
Identifikation af apotek/forhandler som recepten skal sendes til.
key: customer_foreign_key
value: (Varchar)
Påkrævet
Identifikation af eksisterende kunde.
key: name
value: (String)
Påkrævet
Kundens navn
key: address
value: (String)
Påkrævet
Kundens adresse
key: postal_code
value: (String)
Påkrævet
Kundens postnummer
key: phone
value: (String)
Påkrævet
Kundens telefonnummer
key: email
value: (String)
Påkrævet
Kundens E-mail adresse
key: lines
value: (Array med objekter)
Påkrævet
Array med objekt for hver linie på recepten.
key: product_number
value: (String)
Påkrævet
Det nordiske varenummer på produktet.
key: quantity
value: (Integer)
Påkrævet
Antal enheder/pakninger.
key: sold_to_id
value: (Integer)
Påkrævet
Angiver dyregruppen [animal_group_id]
key: animal_plural
value: (Boolean)
Valgfri
Angiver om angivelsen af dyr skal være i ental eller flertal.
key: animal_id
value: (Integer)
Påkrævet
Angiver hvilket dyr som er valgt.
key: age_id
value: (Integer)
Delvis påkrævet **
Angivelse af den valgte dyrealder.
key: indication_id
value: (Integer)
Påkrævet
Angiver hvilken indikation som er valgt.
key: dose_number
value: (Varchar)
Valgfri
Værdien af doseringen.
key: dose_unit_id
value: (Integer)
Valgfri
Angiver doseringens enhedstype.
key: dose_factor_number
value: (Integer)
Valgfri
Angiver værdien af doseringsfaktoren.
key: dose_factor_unit_id
value: (Integer)
Valgfri
Angiver doseringsfaktorens enhedstype.
key: administration_route_id
value: (Integer)
Valgfri
Angiver indgivelsesmetoden.
key: frequenzy_state
value: (Boolean)
Valgfri
Angiver den ønskede skriveform på etiketten.
Standard værdi false.
key: duration_number
value: (Integer)
Valgfri
Angiver værdien af varigheden.
key: duration_unit_id
value: (Integer)
Valgfri
Angiver varighedens enhedstype.
key: frequenzy_number
value: (Integer)
Valgfri
Angiver værdien af hyppigheden.
key: frequenzy_unit_id
value: (Integer)
Valgfri
Angiver hyppighedens enhedstype.
key: slaughter_quarantine_number
value: (Integer)
Valgfri
Angiver værdien af eventuel slagtefrist.
key: slaughter_quarantine_unit_id
value: (Integer)
Valgfri
Angiver slagtefristens enhedstype.
key: dairy_quarantine_number
value: (Integer)
Valgfri
Angiver værdien af eventuel mælkefrist.
key: dairy_quarantine_unit_id
value: (Integer)
Valgfri
Angiver mælkefristens enhedstype.
key: custom_label
value: (Text)
Valgfri
Ordinationsteksten til brugerdefineret label.
* Kunden skal identificeres medcustomer_id eller alle kundens stamdata.
** Linjer på erhvervsrecepter skal indeholde vetstatkoder. [species_id], [age_id], [prescription_group_id]
  • Eksempel: Privat recept med kunde-id som reference [customer_id] 
    // Data til afsendelse
    
     	{
				"foreign_key": "DEMO1335445DEMO",
				"ordertype_id":3,
				"dealer_id":40,
				"customer_id":8,

				"lines":[
					{
						"product_number": "000164",
						"quantity": 2,
						"sold_to_id": 2,
						"animal_id": 15,
						"age_id": 5,
						"indication_id": 67,
                        "dose_number": "10",
						"dose_units": 1,
                        "dose_factor_number": 40,
						"dose_factor_unit_id": 1,
						"administration_route_id": 2,
                        "frequenzy_number": 1,
						"frequenzy_unit_id": 1,
						"duration_number": 3,
						"duration_unit_id": 1,
						"slaughter_quarantine_number": 20,
						"slaughter_quarantine_unit": 1
					},
					{
					"product_number": "000189",
					"quantity": 2,
					"sold_to_id": 2,
					"animal_id": 15,
					"species_id": 90,
					"age_id": 0,
					"indication_id": 129,
					"custom_label": "Til kat mod smerter, 3 mg pr. 4 g. dyr, i drikkeva.."
				}
			   ]
			}
     
    //Eksempel på POST-request data i json-format (identifikation med customer_id):
  • Eksempel: Privat recept med kundens stamdata 
    // Data til afsendelse
    
     {
                "foreign_key": "DEMO1335445DEMO",
				"ordertype_id":3,
				"dealer_id": 40,
				"name": "Jens Hansen",
				"address": "Solbakken 7",
				"postal_code": "9000",
				"phone": "12345678",
				"email": "jenshansen@test.dk"

				"lines":[
					{
                        "product_number": "000164",
						"quantity": 2,
						"sold_to_id": 2,
						"animal_id": 15,
						"age_id": 5,
						"indication_id" 67:
                        "dose_number": "10",
						"dose_units": 1,
                        "dose_factor_number": 40,
						"dose_factor_unit_id": 1,
						"administration_route_id": 2,
                        "frequenzy_number": 1,
						"frequenzy_unit_id": 1,
						"duration_number": 3,
						"duration_unit_id": 1,
						"slaughter_quarantine_number": 20,
						"slaughter_quarantine_unit": 1
					},
					{
				    "product_number": "000189",
					"quantity": 2,
					"sold_to_id": 2,
					"species_id": 90,
					"age_id": 0,
					"indication_id": 129,
					"custom_label": "Til kat mod smerter, 3 mg pr. 4 g. dyr, i drikkeva.."
				}
			   ]
			}
     
    //Eksempel på POST-request data i json-format (identifikation med kundens stamdata):

Postman vejledning

I Postman er det let at opsætte og teste forskellige forespørgsler. Det gælder både GET og POST forespørgsler. Nedenfor kan du se nogle simple anvisninger på hvordan du kommer i gang med Pharmo API.

Postman GET forespørgsel

I Postman er det let at opsætte og teste forskellige forespørgsler. URL-parametre kan opsættes under fanen: Params

  1. Vælg GET som type af forespørgsel. [GET]
  2. Angiv navnet på parameteret under KEY [supplier_key]
  3. Angiv værdien på parameteret under VALUE [Indsæt 64-cifrede supplier_key]

En række forespørgsler kræver også en access_token i headeren. Se opsætningen på billedet nedenfor:

Postman POST forespørgsel

I Postman er det let at opsætte og teste forskellige forespørgsler. Ved POST forespørgsler medsendes supplier_key data i Body. I eksemplet nedenfor sendes data for en recept.

  1. Vælg POST som type af forespørgsel. [POST]
  2. Angiv URL til den ønskede forespørgsel. F.eks: [https://pharmo.dk/api/v1/prescriptions]
  3. Angiv de data som skal sendes med hver forespørgsel. Eventuelt som [form-data]

Alle POST-forespørgsler kræver en access_token i headeren. Se opsætningen på billedet nedenfor:

Send Erhvervsrecept via Pharmo API

Dette endpoint anvendes til landmandsrecepter. Her kræves CHR-nummer, samt besætningsnummer.

Identifikation via fremmednøgle

Du kan udfylde felet foreign_key og dermed anvende din egen kundenøgle til identifikation af kunden.

Når feltet er udfyldt, tjekker Pharmo API om en kunde med denne nøgle eksisterer for den pågældende praksis. I skal altid sende alle kundedata i forbindelse med recepten, så vil kunden på Pharmo blive opdateret med jeres seneste oplysninger

Ved test kan du med fordel bruge dealer_id = 40, dermed sendes recepten til en testforhandler.

Opsæt en test i Postman, dermed kan API'et afprøves inden den faktiske integration.

POST-request til:
https://pharmo.dk/api/v1/prescriptions/private
I headeren angives:
key: Authorization
value: Bearer <-indsæt den genererede access_token->
Token til identifikation af dyrlæge/bruger på Pharmo. Hvis en praksis har flere brugere, skal der anvendes en unik token for hver bruger.
key: Content-Type
value: application/json

Medsend følgende form-data:

key: foreign_key
value: (String)
Påkrævet
IT-leverandørens egen reference til recepten.
key: dealer_id
value: (Integer)
Påkrævet
Identifikation af apotek/forhandler som recepten skal sendes til.
key: customer_foreign_key
value: (Varchar)
Påkrævet
Identifikation af eksisterende kunde.
key: name
value: (String)
Påkrævet
Kundens navn
key: address
value: (String)
Påkrævet
Kundens adresse
key: postal_code
value: (String)
Påkrævet
Kundens postnummer
key: phone
value: (String)
Valgfri
Kundens telefonnummer
key: email
value: (String)
Valgfri
Kundens E-mail adresse (ved ny kunde)
key: cvr_number
value: (String)
Valgfri
Kundens CVRnr.
key: herd_number
value: (Varchar)
Påkrævet
Besætningsnummer
key: chr_number
value: (Varchar)
Påkrævet
Identifikation af ejendom
key: lines
value: (Array med objekter)
Påkrævet
Array med objekt for hver linie på recepten.
key: product_number
value: (String)
Påkrævet
Det nordiske varenummer på produktet.
key: quantity
value: (Integer)
Påkrævet
Antal enheder/pakninger.
key: sold_to_id
value: (Integer)
Påkrævet
Angiver dyregruppen [animal_group_id]
key: animal_plural
value: (Boolean)
Valgfri
Angiver om angivelsen af dyr skal være i ental eller flertal.
key: animal_id
value: (Integer)
Påkrævet
Angiver hvilket dyr som er valgt.
key: age_id
value: (Integer)
Påkrævet
Angivelse af den valgte dyrealder.
key: indication_id
value: (Integer)
Påkrævet
Angiver hvilken indikation som er valgt.
key: dose_number
value: (Varchar)
Valgfri
Værdien af doseringen.
key: dose_unit_id
value: (Integer)
Valgfri
Angiver doseringens enhedstype.
key: dose_factor_number
value: (Integer)
Valgfri
Angiver værdien af doseringsfaktoren.
key: dose_factor_unit_id
value: (Integer)
Valgfri
Angiver doseringsfaktorens enhedstype.
key: administration_route_id
value: (Integer)
Valgfri
Angiver indgivelsesmetoden.
key: frequenzy_state
value: (Boolean)
Valgfri
Angiver den ønskede skriveform på etiketten.
Standard værdi false.
key: duration_number
value: (Integer)
Valgfri
Angiver værdien af varigheden.
key: duration_unit_id
value: (Integer)
Valgfri
Angiver varighedens enhedstype.
key: frequenzy_number
value: (Integer)
Valgfri
Angiver værdien af hyppigheden.
key: frequenzy_unit_id
value: (Integer)
Valgfri
Angiver hyppighedens enhedstype.
key: slaughter_quarantine_number
value: (Integer)
Valgfri
Angiver værdien af eventuel slagtefrist.
key: slaughter_quarantine_unit_id
value: (Integer)
Valgfri
Angiver slagtefristens enhedstype.
key: dairy_quarantine_number
value: (Integer)
Valgfri
Angiver værdien af eventuel mælkefrist.
key: dairy_quarantine_unit_id
value: (Integer)
Valgfri
Angiver mælkefristens enhedstype.
key: custom_label
value: (Text)
Valgfri
Ordinationsteksten til brugerdefineret label.
key: vetstat_custom_species
value: (Integer)
Valgfri
Brugerdefineret vetstatkode for dyreart
key: vetstat_custom_age
value: (Integer)
Valgfri
Brugerdefineret vetstatkode for dyrealder
key: vetstat_custom_prescription_group
value: (Integer)
Valgfri
Brugerdefineret vetstatkode for ordinationsgruppe
  • Eksempel: Erhvervsrecept 
    // Data til afsendelse
    
     {
                "foreign_key": "123000",
                "dealer_id": 40,
                "customer_foreign_key": "361",
                "name": "Test Customer",
                "address": "Test Vej 33",
                "postal_code": "9000",
                "phone": null,
                "email": "email@test.com",
                "chr_number": "97035",
                "herd_number": "97035",
                "cvr_number": "12345678",

				"lines":[
                       {
                        "id": 18676,
                        "prescription_id": 14227,
                        "product_number": "461111",
                        "product_name": "Alamycin Prolongatum Vet.",
                        "quantity": 1,
                        "sold_to_id": 1,
                        "species_code": 15,
                        "age_code": 0,
                        "prescription_group_code": 11,
                        "animal_id": 1,
                        "indication_id": 78,
                        "dose_number": "10",
                        "dose_unit_id": 1,
                        "dose_factor_number": 40,
                        "dose_factor_unit_id": 1,
                        "administration_route_id": 2,
                        "duration_number": 3,
                        "duration_unit_id": 3,
                        "frequenzy_state": 0,
                        "frequenzy_number": 1,
                        "frequenzy_unit_id": "1",
                        "slaughter_quarantine_number": 20,
                        "slaughter_quarantine_unit_id": 1,
                        "dairy_quarantine_number": 20,
                        "dairy_quarantine_unit_id": 1,
                        "custom_label": null,
                        "use_frequenzy_number": 2,
                        "use_frequenzy_unit_id": 3,
                        "use_count": 2,
                        "cascade_used": 1,
                        "antibiotics_treatment": 1,
                        "allow_substitution": 1,
                        "vetstat_custom_species": null,
                        "vetstat_custom_age": null,
                        "vetstat_custom_prescription_group": null,
                        "species_id": 1,
                        "age_id": null,
                        "prescription_group_id": 2
                       }
                ]
			}
     
    //Eksempel på POST-request data i json-format (identifikation med kundens stamdata):
  • Se eksempel på returneret data 
    //Returneret data
    
     {
    "id": 6989,
    "ordertype_id": 3,
    "it_supplier_id": null,
    "practice_id": 1,
    "user_id": 1,
    "user_auth_id": "9999",
    "dealer_id": 40,
    "customer_id": 8,
    "cvr_number": null,
    "herd_number": "97035",
    "name": "Casper Nøhr Hansen",
    "company_name": null,
    "address": "Nytorv 3",
    "postal_code": "9000",
    "phone": "60631409",
    "note": "Dette er en test recept",
    "submitted_at": "2021-11-18 11:29:08",
    "lines": [
        {
            "id": 8620,
            "prescription_id": 6989,
            "product_number": "036275",
            "product_name": "Parofor",
            "quantity": 1,
            "sold_to_id": 1,
            "species_id": 12,
            "age_id": 62,
            "prescription_group_id": 12,
            "animal_id": 20,
            "indication_id": 12,
            "dose_number": "10",
            "dose_unit_id": 1,
            "dose_factor_number": 40,
            "dose_factor_unit_id": 1,
            "administration_route_id": 2,
            "duration_number": 3,
            "duration_unit_id": 1,
            "frequenzy_state": 0,
            "frequenzy_number": 1,
            "frequenzy_unit_id": "1",
            "slaughter_quarantine_number": 20,
            "slaughter_quarantine_unit_id": 1,
            "dairy_quarantine_number": null,
            "dairy_quarantine_unit_id": null,
            "custom_label": null,
            "use_frequenzy_number": null,
            "use_frequenzy_unit_id": null,
            "use_count": null
        }
    ]
}

Postman vejledning

I Postman er det let at opsætte og teste forskellige forespørgsler. Det gælder både GET og POST forespørgsler. Nedenfor kan du se nogle simple anvisninger på hvordan du kommer i gang med Pharmo API.

Postman GET forespørgsel

I Postman er det let at opsætte og teste forskellige forespørgsler. URL-parametre kan opsættes under fanen: Params

  1. Vælg GET som type af forespørgsel. [GET]
  2. Angiv navnet på parameteret under KEY [supplier_key]
  3. Angiv værdien på parameteret under VALUE [Indsæt 64-cifrede supplier_key]

En række forespørgsler kræver også en access_token i headeren. Se opsætningen på billedet nedenfor:

Postman POST forespørgsel

I Postman er det let at opsætte og teste forskellige forespørgsler. Ved POST forespørgsler medsendes supplier_key data i Body. I eksemplet nedenfor sendes data for en recept.

  1. Vælg POST som type af forespørgsel. [POST]
  2. Angiv URL til den ønskede forespørgsel. F.eks: [https://pharmo.dk/api/v1/prescriptions]
  3. Angiv de data som skal sendes med hver forespørgsel. Eventuelt som [form-data]

Alle POST-forespørgsler kræver en access_token i headeren. Se opsætningen på billedet nedenfor: