{ "resourceType": "CapabilityStatement", "id": "ncdhc-metadata-consumer", "text": { "status": "generated", "div": "
\n \nNational Children's Digital Health Collaborative CapabilityStatement (Consumer)
" }, "name": "National Children's Digital Health Collaborative CapabilityStatement (Consumer)", "title": "National Children's Digital Health Collaborative CapabilityStatement (Consumer)", "status": "draft", "date": "2020-01-19", "publisher": "National Children's Digital Health Collaborative", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Capability Statement for National Children's Digital Health Collaborative Consumer Channel", "kind": "instance", "software": { "name": "NCDHC FHIR Server", "version": "v1.0.0", "releaseDate": "2020-04-30" }, "implementation": { "description": "NCDHC FHIR Server", "url": "https://con.ncdhc.health.nsw.gov.au" }, "fhirVersion": "3.0.2", "acceptUnknown": "no", "format": [ "json" ], "rest": [ { "mode": "server", "documentation": "Capability Statement for National Children's Digital Health Collaborative", "security": { "extension": [ { "extension": [ { "url": "token", "valueUri": "https://authncdhc.b2clogin.com/authncdhc.onmicrosoft.com/B2C_1_NCDHC_Connect_Signin/oauth2/v2.0/token" }, { "url": "authorize", "valueUri": "https://authncdhc.b2clogin.com/authncdhc.onmicrosoft.com/B2C_1_NCDHC_Connect_Signin/oauth2/v2.0/authorize" } ], "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" } ], "cors": true, "service": [ { "coding": [ { "system": "http://hl7.org/fhir/restful-security-service", "code": "SMART-on-FHIR" } ] }, { "coding": [ { "system": "http://hl7.org/fhir/restful-security-service", "code": "OAuth" } ] } ], "description": "NCDHC FHIR server uses standard OAuth 2.0 for Consumer interactions. Consumer interactsion are supported by Smart-On-FHIR Launch sequences" }, "resource": [ { "type": "Person", "profile": { "reference": "http://hl7.org/fhir/StructureDefinition/Person" }, "documentation": "Provide details on what can be done on the Person resource", "interaction": [ { "code": "read", "documentation": "Reads a Patient instance based on the input Person.id" }, { "code": "search-type", "documentation": "When a client searches Person with no search criteria, they get a list of all Person instances they have access too. Servers may elect to offer additional search parameters, but this is not required" } ], "versioning": "versioned", "searchParam": [ { "name": "identifier", "type": "token", "documentation": "A Person identifier. 'family', 'gender', 'birthdate' is mandatory when searched with identifier" }, { "name": "given", "type": "string", "documentation": "A portion of the family name of the Person. This is mandatory and allowed when searched using identifier. FHIR type is string" }, { "name": "family", "type": "string", "documentation": "A portion of the given name of the Person. This can only be provided when searched with identifier." }, { "name": "birthdate", "type": "date", "documentation": "The Person's date of birth. only 'eq' is supporrted. This is mandatory and allowed when searched using identifier." }, { "name": "gender", "type": "token", "documentation": "Gender of the Person. This is mandator and allowed when searched using identifier." } ] }, { "type": "RelatedPerson", "profile": { "reference": "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson" }, "documentation": "Provide details on what can be done on the RelatedPerson resource", "interaction": [ { "code": "read", "documentation": "Reads a RelatedPerson instance based on the input RelatedPerson.id" } ] }, { "type": "Patient", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-patient-baby" }, "documentation": "Provide details on what can be done on the Patient resource", "interaction": [ { "code": "read", "documentation": "Reads a Patient instance based on the input Patient.id" }, { "code": "search-type", "documentation": "When a client searches patients with no search criteria, they get a list of all patients they have access too. Servers may elect to offer additional search parameters, but this is not required" } ], "versioning": "versioned", "searchParam": [ { "name": "identifier", "type": "token", "documentation": "A patient identifier. 'family', 'gender', 'birthdate' is mandatory when searched with identifier" }, { "name": "given", "type": "string", "documentation": "A portion of the family name of the patient. This is mandatory and allowed when searched using identifier. FHIR type is string" }, { "name": "family", "type": "string", "documentation": "A portion of the given name of the patient. This can only be provided when searched with identifier." }, { "name": "birthdate", "type": "date", "documentation": "The patient's date of birth. only 'eq' is supporrted. This is mandatory and allowed when searched using identifier." }, { "name": "gender", "type": "token", "documentation": "Gender of the patient. This is mandator and allowed when searched using identifier." } ] }, { "type": "Consent", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-consent" }, "documentation": "Provide details on what can be done on the Consent resource", "interaction": [ { "code": "search-type", "documentation": "Searches Consent instances based on the search criteria provided" } ], "versioning": "versioned", "searchParam": [ { "name": "category", "type": "token", "documentation": "Classification of the consent statement - for indexing/retrieval" }, { "name": "consentor", "type": "reference", "documentation": "Who is agreeing to the policy and rules" }, { "name": "date", "type": "date", "documentation": "When this Consent was created or indexed" } ] }, { "type": "AuditEvent", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-audit-event" }, "documentation": "Provide details on what can be done on the AuditEvent resource", "interaction": [ { "code": "search-type", "documentation": "Searches AuditEvent instances based on the search criteria provided" } ], "versioning": "versioned", "searchParam": [ { "name": "patient", "type": "reference", "documentation": "Patient reference for which the AuditEvent instances should be fetched" }, { "name": "agent", "type": "reference", "documentation": "Identifier of who" }, { "name": "date", "type": "date", "documentation": "Time when the event was recorded. System SHALL support 'ge', 'le' and 'eq' search as per FHIR standard" }, { "name": "agent-role", "type": "token", "documentation": "Agent role in the event" }, { "name": "action", "type": "token", "documentation": "Type of action performed during the event" } ] } ], "operation": [ { "name": "NCDHC OperationDefination $document", "definition": { "reference": "http://hl7.org/fhir/OperationDefinition/Composition-document" } }, { "name": "NCDHC OperationDefination $view-document", "definition": { "reference": "http://hl7.org.au/fhir/ch/v1/OperationDefinition/ncdhc-composition-view-document" } } ] } ], "document": [ { "mode": "consumer", "documentation": "NCDHC Birth Consolidated view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-birth" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Schedule view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-schedule" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Summary view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-summary" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 1-4 Weeks view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-14wks" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 6-8 Weeks view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-68wks" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 6 Months view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-6m" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 12 Months view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-12m" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 18 Months view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-18m" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 2 Years view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-2yr" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 3 Years view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-3yr" } }, { "mode": "consumer", "documentation": "NCDHC Health Check Assessment 4 Years view", "profile": { "reference": "http://hl7.org.au/fhir/ch/v1/StructureDefinition/ncdhc-composition-view-hca-4yr" } } ] }