Annuaire Santé
1.0.0-ballot-2 - STU1
Annuaire Santé
1.0.0-ballot-2 - STU1
This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-2: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
| Active as of 2023-03-23 |
{
"resourceType" : "CapabilityStatement",
"id" : "AsClientCapabilityStatement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>AsRestServer</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></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 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=\"POST a new resource (create interaction)\">Create</b></th></tr><tr><td>Device</td><td><a href=\"http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-device\">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-device</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>HealthcareService</td><td><a href=\"http://hl7.org/fhir/StructureDefinition/HealthcareService\">http://hl7.org/fhir/StructureDefinition/HealthcareService</a></td><td>y</td><td>y</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></tr><tr><td>Organization</td><td><a href=\"http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization\">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href=\"http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioner\">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>PractitionerRole</td><td><a href=\"http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerrole\">http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerrole</a></td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Subscription</td><td><a href=\"http://hl7.org/fhir/StructureDefinition/Subscription\">http://hl7.org/fhir/StructureDefinition/Subscription</a></td><td>y</td><td>y</td><td>y</td><td></td></tr></table></div>"
},
"url" : "https://interop.esante.gouv.fr/ig/fhir/annuaire/CapabilityStatement/AsClientCapabilityStatement",
"version" : "1.0.0-ballot-2",
"name" : "AsRestServer",
"status" : "active",
"date" : "2023-03-23T13:49:59.485+00:00",
"publisher" : "ANS",
"contact" : [
{
"name" : "ANS",
"telecom" : [
{
"system" : "url",
"value" : "https://esante.gouv.fr"
},
{
"system" : "email",
"value" : "monserviceclient.annuaire@esante.gouv.fr"
}
]
}
],
"kind" : "instance",
"software" : {
"name" : "Afas Fhir server",
"version" : "V1-R4"
},
"implementation" : {
"description" : "Afas data",
"url" : "https://gateway.api.esante.gouv.fr/fhir/v1"
},
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"xml",
"application/fhir+json",
"json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Device",
"profile" : "http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-device",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*",
"Device:organization"
],
"searchRevInclude" : [
"Device:location",
"Device:organization",
"HealthcareService:organization",
"Organization:endpoint",
"Organization:partof",
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "Recherche sur l'id de la ressource Device"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la periode donnée"
},
{
"name" : "_since",
"type" : "date"
},
{
"name" : "_total",
"type" : "string"
},
{
"name" : "device-name",
"type" : "string",
"documentation" : "The device name"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Recherche sur l'identifiant de l'équipement matériel lourd"
},
{
"name" : "location",
"type" : "reference",
"documentation" : "The location of the device"
},
{
"name" : "manufacturer",
"type" : "string",
"documentation" : "Recherche sur la marque des équipements matériels lourds"
},
{
"name" : "model",
"type" : "string",
"documentation" : "The model of the device"
},
{
"name" : "number-authorization-arhgos",
"type" : "string",
"documentation" : "Recherche sur le numéro d'autorisation ARHGOS"
},
{
"name" : "organization",
"type" : "reference",
"documentation" : "Recherche les équipements matériels lourds rattachés à la structure sélectionnée"
},
{
"name" : "status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error | unknown"
},
{
"name" : "type",
"type" : "token",
"documentation" : "Recherche sur le type de l'équipement matériel lourd"
}
]
},
{
"type" : "HealthcareService",
"profile" : "http://hl7.org/fhir/StructureDefinition/HealthcareService",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*",
"HealthcareService:organization"
],
"searchRevInclude" : [
"Device:location",
"Device:organization",
"HealthcareService:organization",
"Organization:endpoint",
"Organization:partof",
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "Any id for the healthcare service"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Only return resources which were last updated as specified by the given range"
},
{
"name" : "_profile",
"type" : "uri",
"documentation" : "Sélectionner le profil de la ressource Healthcare Service. Pour les activités de soins http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-healthcareservice-healthcare-activity / ; Pour les équipements sociaux http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-healthcareservice-social-equipment"
},
{
"name" : "_since",
"type" : "date"
},
{
"name" : "_total",
"type" : "string"
},
{
"name" : "active",
"type" : "token",
"documentation" : "Recherche que les ressources Healthcare Service actives"
},
{
"name" : "characteristic",
"type" : "token",
"documentation" : "Recherche sur le type d'activité des équipements sociaux ou sur la forme d'activité des activités de soins"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Recherche sur l'identifiant des équipements sociaux ou des activités de soins"
},
{
"name" : "organization",
"type" : "reference",
"documentation" : "Recherche tous les équipements sociaux ou activités de soins rattachés à une structure"
},
{
"name" : "service-category",
"type" : "token",
"documentation" : "Recherche sur la modalité des activités de soins"
},
{
"name" : "service-type",
"type" : "token",
"documentation" : "Recherche sur la discipline des équipements sociaux ou sur l'activité sanitaire régulée des activité de soins"
}
]
},
{
"type" : "OperationDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction" : [
{
"code" : "read"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"Device:location",
"Device:organization",
"HealthcareService:organization",
"Organization:endpoint",
"Organization:partof",
"PractitionerRole:organization",
"PractitionerRole:practitioner"
]
},
{
"type" : "Organization",
"profile" : "http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*",
"Organization:partof"
],
"searchRevInclude" : [
"Device:location",
"Device:organization",
"HealthcareService:organization",
"Organization:endpoint",
"Organization:partof",
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "Recherche sur l'id de la ressource Organization"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée"
},
{
"name" : "_since",
"type" : "date"
},
{
"name" : "_total",
"type" : "string"
},
{
"name" : "active",
"type" : "token",
"documentation" : "Recherche que les ressources Organizations actives"
},
{
"name" : "address",
"type" : "string",
"documentation" : "Recherche sur (une partie) de l'adresse de la structure."
},
{
"name" : "address-city",
"type" : "string",
"documentation" : "Recherche sur la commune spécifiée dans une adresse"
},
{
"name" : "address-country",
"type" : "string",
"documentation" : "Recherche sur le pays spécifié dans une adresse"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "Recherche sur le code postal spécifié dans une adresse"
},
{
"name" : "address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "address-use",
"type" : "token",
"documentation" : "Recherche sur un code use spécifié dans adresse"
},
{
"name" : "endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for the organization"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Recherche sur tous les identifiants des structures"
},
{
"name" : "mailbox-mss",
"type" : "string",
"documentation" : "Recherche sur les messageries sécurisées de santé rattachées aux Organization"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Recherche sur la raison sociale des structures"
},
{
"name" : "partof",
"type" : "reference",
"documentation" : "Recherche tous les établissements géographiques rattachés à une même entité juridique"
},
{
"name" : "pharmacy-licence",
"type" : "string",
"documentation" : "Recherche sur le numéro de licence des officines"
},
{
"name" : "type",
"type" : "token",
"documentation" : "Recherche sur le type de structure/ code APE/ catégorie juridique/ secteur d'activité/ catégorie d'établissement ou le code SPH de la structure"
}
]
},
{
"type" : "Practitioner",
"profile" : "http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitioner",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"Device:location",
"Device:organization",
"HealthcareService:organization",
"Organization:endpoint",
"Organization:partof",
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "The ID of the resource"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée"
},
{
"name" : "_since",
"type" : "date"
},
{
"name" : "_total",
"type" : "string"
},
{
"name" : "active",
"type" : "token",
"documentation" : "Recherche les ressources Practitioner actives"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Recherche sur tous les identifiants des professionnels de santé"
},
{
"name" : "mailbox-mss",
"type" : "string"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Une recherche définie par le serveur qui peut correspondre à n'importe quel champ de HumanName, ici sur le préfix correspondant à la civilité des professionnels de santé"
}
]
},
{
"type" : "PractitionerRole",
"profile" : "http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-practitionerrole",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*",
"PractitionerRole:organization",
"PractitionerRole:partof",
"PractitionerRole:practitioner"
],
"searchRevInclude" : [
"Device:location",
"Device:organization",
"HealthcareService:organization",
"Organization:endpoint",
"Organization:partof",
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "l'id de la ressource"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Renvoie uniquement les ressources qui ont été mises à jour pour la dernière fois comme spécifié par la période donnée"
},
{
"name" : "_since",
"type" : "date"
},
{
"name" : "_total",
"type" : "string"
},
{
"name" : "active",
"type" : "token",
"documentation" : "Recherche les ressources PractitionerRole actives"
},
{
"name" : "family",
"type" : "string",
"documentation" : "Recherche sur le nom d'exercice des professionnels de santé"
},
{
"name" : "given",
"type" : "string",
"documentation" : "Recherche sur le prénom d'exercice des professionnels de santé"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Any identifier for the practitioner role"
},
{
"name" : "mailbox-mss",
"type" : "string",
"documentation" : "Recherche sur les messageries sécurisées de santé rattachées à la situation d'exercice des Professionnel de santé"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Une recherche définie par le serveur qui peut correspondre à n'importe quel champ de l'élément name : Code civilité d’exercice, le nom ou prénom d'exercice des professionnel de santé."
},
{
"name" : "number-smartcard",
"type" : "string",
"documentation" : "Recherche sur le numéro de carte des professionnels de santé"
},
{
"name" : "organization",
"type" : "reference",
"documentation" : "Recherche les exercices professionnels et les situation d'exercice rattachés à la structure sélectionnée"
},
{
"name" : "practitioner",
"type" : "reference",
"documentation" : "Recherche les exercices professionnels et les situation d'exercice rattachés aux professionnels de santé sélectionnés"
},
{
"name" : "role",
"type" : "token",
"documentation" : "Recherche sur la profession/ la catégorie professionnelle/ la fonction/ le genre d'activité/ le mode d'exercice ou la section tableau des pharmaciens"
},
{
"name" : "specialty",
"type" : "token",
"documentation" : "Recherche sur le savoir-faire ou le Type de savoir-faire"
},
{
"name" : "type-smartcard",
"type" : "token",
"documentation" : "Recherche sur le type de carte du professionnels de santé"
}
]
},
{
"type" : "Subscription",
"profile" : "http://hl7.org/fhir/StructureDefinition/Subscription",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"Device:location",
"Device:organization",
"HealthcareService:organization",
"Organization:endpoint",
"Organization:partof",
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "Recherche sur l'id de la ressource Subscription"
},
{
"name" : "criteria",
"type" : "string",
"documentation" : "Recherche sur le critère de la subscription"
},
{
"name" : "payload",
"type" : "token",
"documentation" : "Recherche sur le type de payload de la subscription"
},
{
"name" : "status",
"type" : "token",
"documentation" : "Recherche sur le status de la subscription"
},
{
"name" : "type",
"type" : "token",
"documentation" : "Recherche sur le type de la subscription"
},
{
"name" : "url",
"type" : "string",
"documentation" : "Recherche sur le url (payload) de la subscription"
}
],
"operation" : [
{
"name" : "deactivate-all",
"definition" : "https://gateway.api.esante.gouv.fr/fhir/v1/OperationDefinition/Subscription-t-deactivate-all"
},
{
"name" : "activate-all",
"definition" : "https://gateway.api.esante.gouv.fr/fhir/v1/OperationDefinition/Subscription-t-activate-all"
}
]
}
],
"interaction" : [
{
"code" : "transaction"
}
]
}
]
}
IG © 2020+ ANS. Package ans.fhir.fr.annuaire#1.0.0-ballot-2 based on FHIR 4.0.1. Generated 2023-07-18
Links: Table of Contents |
QA Report
| Version History | New Issue