Skip to content
APIs🔒 Format de donnéesTypes d'entrée partagés

Types d’entrée partagés

Ces types d’entrée sont partagés entre plusieurs endpoints d’API d’analyse clinique. Chaque page de référence d’endpoint renvoie ici pour ces définitions communes tout en documentant ses propres types spécifiques en ligne.

BoundsPeriodInput

Type d’entrée pour définir une période avec des dates de début et de fin.

VariableTypeDescription
endDateLa date de fin de la période
startDateLa date de début de la période

CodingInput

Type d’entrée pour les informations de codage.

VariableTypeDescription
codeString!Le code du codage
terminologyString!Le système de terminologie utilisé

CodingInputWithLabel

Type d’entrée pour les informations de codage avec un libellé.

VariableTypeDescription
codeStringLe code du codage
labelStringLe libellé du codage
terminologyStringLe système de terminologie utilisé

ConditionInput

Type d’entrée pour une condition, incluant le codage et les modificateurs.

VariableTypeDescription
codingCodingInputWithLabel!Le codage de la condition, obligatoire.
modifiers[String!]Une liste de modificateurs associés à la condition.

DosageInstructionInput

Type d’entrée pour les instructions de posologie d’un médicament incluant la dose, la séquence et la temporalité.

VariableTypeDescription
doseAndRate[DoseAndRateInput!]La quantité de dose et le taux d’administration du médicament.
maxDosePerPeriodMaxDosePerPeriodInputLa dose maximale par période
modifierExtension[ExtensionInput!]Extension modificatrice pour l’instruction de posologie
sequenceFloatL’ordre dans lequel les instructions de posologie doivent être administrées.
timingTimingInputLe calendrier d’administration du médicament.

DoseAndRateInput

Type d’entrée pour la dose ou la plage à laquelle un médicament doit être administré. Peut être spécifié comme une quantité précise ou une plage.

VariableTypeDescription
doseQuantityQuantityInputUne quantité précise spécifiant la dose du médicament.
doseRangeRangeInputUne plage spécifiant les limites de dose autorisées du médicament.

DrugInput

Permet de spécifier le code utilisé pour identifier le médicament.

VariableTypeDescription
brandedDrugCodingInputLe code utilisé pour identifier le médicament si c’est une spécialité
clinicalDrugCodingInputLe code utilisé pour identifier le médicament clinique
idStringL’identifiant unique du médicament
packagedDrugCodingInputLe code utilisé pour identifier la présentation

ExtensionInput

Type d’entrée pour définir une extension avec une URL et un codage de valeur.

VariableTypeDescription
urlString!L’URL qui identifie l’extension
valueBooleanBooleanLa valeur booléenne associée à cette extension
valueCodingValueCodingInputLe codage de valeur associé à cette extension

MaxDosePerPeriodInput

Entrée utilisée pour définir la dose maximale et la période associée pour l’administration d’un médicament.

VariableTypeDescription
denominatorQuantityInput!La période
numeratorQuantityInput!La dose

MedicationRequestInput

Entrée utilisée pour définir la structure d’une demande de médicament.

VariableTypeDescription
dosageInstruction[DosageInstructionInput!]Une liste d’instructions de posologie pour ce médicament
drugDrugInput!Le médicament correspondant

ObservationInput

Type d’entrée pour les détails d’une observation.

VariableTypeDescription
codingCodingInputWithLabel!Détails de codage pour l’observation
valueDateTimeDateValeur de date et heure pour l’observation
valueQuantityQuantityInputValeur de quantité pour l’observation

PatientInput

Type d’entrée pour les détails du patient.

VariableTypeDescription
ageGroups[AgeGroup!]Liste des tranches d’âge du patient.
birthdateDateLa date de naissance du patient.
concurrentTreatmentsTreatmentInputTraitements concomitants du patient.
conditions[ConditionInput!]Pathologies diagnostiquées chez le patient.
observations[ObservationInput!]Liste des observations pour le patient
sexGenderSexe biologique.

QuantityInput

Entrée utilisée pour définir une quantité pour un dosage ou une mesure médicamenteuse avec des attributs spécifiques.

VariableTypeDescription
codeString!Un code correspondant à l’unité dans le système défini.
systemString!Le système dans lequel l’unité de mesure est définie.
valueFloat!La valeur numérique de la quantité.

RangeInput

Entrée pour définir une plage pour le dosage ou les limites de mesure d’un médicament avec des attributs spécifiques pour les bornes inférieure et supérieure.

VariableTypeDescription
highQuantityInputLa borne supérieure de la plage.
lowQuantityInputLa borne inférieure de la plage.

RepeatInput

Entrée pour définir le motif de répétition d’un événement ou d’une action.

VariableTypeDescription
boundsDurationQuantityInputLa durée pendant laquelle la répétition est bornée.
boundsPeriodBoundsPeriodInputLa période pendant laquelle la répétition est bornée.
boundsRangeRangeInputLa plage dans laquelle la répétition est bornée.
countFloatLe nombre de fois que l’événement ou l’action doit se répéter.
countMaxFloatLe nombre maximum de fois que l’événement ou l’action doit se répéter.
dayOfWeek[DayOfWeek!]Les jours de la semaine où l’événement ou l’action doit se produire.
durationFloatLa durée de chaque répétition.
durationMaxFloatLa durée maximale de chaque répétition.
durationUnitStringL’unité de temps pour la durée de chaque répétition.
frequencyFloatLa fréquence des répétitions dans une période donnée.
frequencyMaxFloatLa fréquence maximale des répétitions dans une période donnée.
periodFloatLa période ou l’intervalle entre les répétitions.
periodMaxFloatLa période ou l’intervalle maximum entre les répétitions.
periodUnitStringL’unité de temps pour la période ou l’intervalle entre les répétitions.
timeOfDay[String!]Heure précise du jour où l’événement ou l’action doit se produire (ex. 16:00:00).
when[When!]Moment précis de la journée où l’événement ou l’action doit se produire (ex. NOON).

TimingInput

Entrée pour définir la temporalité d’administration du médicament.

VariableTypeDescription
modifierExtension[ExtensionInput!]Extension modificatrice pour le repeat input
repeatRepeatInput!Objet contenant les informations sur la temporalité d’administration.

TreatmentInput

Type d’entrée pour spécifier les détails d’un traitement.

VariableTypeDescription
ingredients[String!]Liste des ingrédients impliqués dans le traitement.
procedures[String!]Liste des procédures impliquées dans le traitement.
therapeuticClasses[String!]Liste des classes thérapeutiques impliquées dans le traitement.

ValueCodingInput

Type d’entrée pour définir un codage de valeur avec un système et un code.

VariableTypeDescription
codeString!Le code au sein du système
systemString!Le système qui définit le codage