Composition_GET

GET {{baseUrl}}/Composition?patient=<string>&attester=<string>&author=<string>&encounter=<string>&entry=<string>&related-ref=<string>&subject=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&date=<date>&identifier=<string>&type=<string>&class=<string>&confidentiality=<string>&context=<string>&period=<date>&related-id=<string>&section=<string>&status=<string>&title=<string>&_format=<string>

Request Params

KeyDatatypeRequiredDescription
patientstringMultiple Resources:
  • ReferralRequest: Who the referral is about

  • DocumentManifest: The subject of the set of documents

  • Goal: Who this goal is intended for

  • Consent: Who the consent applies to

  • DocumentReference: Who/what is the subject of the document

  • ImagingManifest: Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)

  • RiskAssessment: Who/what does assessment apply to?

  • CareTeam: Who care team is for

  • ImagingStudy: Who the study is about

  • FamilyMemberHistory: The identity of a subject to list family member history items for

  • Encounter: The patient ro group present at the encounter

  • DeviceUseStatement: Search by subject - a patient

  • DeviceRequest: Individual the service is ordered for

  • AllergyIntolerance: Who the sensitivity is for

  • CarePlan: Who care plan is for

  • EpisodeOfCare: The patient who is the focus of this episode of care

  • Procedure: Search by subject - a patient

  • List: If all resources have the same subject

  • Immunization: The patient for the vaccination record

  • VisionPrescription: The identity of a patient to list dispenses for

  • ProcedureRequest: Search by subject - a patient

  • Flag: The identity of a subject to list flags for

  • Observation: The subject that the observation is about (if patient)

  • DiagnosticReport: The subject of the report if a patient

  • NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement

  • Condition: Who has the condition?

  • Composition: Who and/or what the composition is about

  • DetectedIssue: Associated patient

  • SupplyDelivery: Patient for whom the item is supplied

  • ClinicalImpression: Patient or group assessed | | attester | string | | Who attested the composition | | author | string | | Who and/or what authored the composition | | encounter | string | | Multiple Resources:

  • DocumentReference: Context of the document content

  • RiskAssessment: Where was assessment performed?

  • DeviceRequest: Encounter or Episode during which request was created

  • Procedure: Search by encounter

  • List: Context in which list created

  • VisionPrescription: Return prescriptions with this encounter identifier

  • ProcedureRequest: An encounter in which this request is made

  • Flag: Alert relevant during encounter

  • Observation: Encounter related to the observation

  • DiagnosticReport: The Encounter when the order was made

  • NutritionOrder: Return nutrition orders with this encounter identifier

  • Composition: Context of the Composition | | entry | string | | A reference to data that supports this section | | related-ref | string | | Target of the relationship | | subject | string | | Who and/or what the composition is about | | _id | string | | Logical id of this artifact | | _lastUpdated | string | | When the resource version last changed | | _profile | string | | Profiles this resource claims to conform to | | _security | string | | Security Labels applied to this resource | | _tag | string | | Tags applied to this resource | | date | string | | Multiple Resources:

  • Consent: When this Consent was created or indexed

  • SupplyRequest: When the request was made

  • RiskAssessment: When was assessment made?

  • CareTeam: Time period team covers

  • FamilyMemberHistory: When history was captured/updated

  • Encounter: A date within the period the Encounter lasted

  • AllergyIntolerance: Date record was believed accurate

  • CarePlan: Time period plan covers

  • EpisodeOfCare: The provided date search value falls within the episode of care's period

  • Procedure: Date/Period the procedure was performed

  • List: When the list was prepared

  • Immunization: Vaccination (non)-Administration Date

  • Flag: Time period when flag is active

  • Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period

  • DiagnosticReport: The clinically relevant time of the report

  • Composition: Composition editing time

  • DetectedIssue: When identified

  • ClinicalImpression: When the assessment was documented | | identifier | string | | Multiple Resources:

  • DocumentManifest: Unique Identifier for the set of documents

  • Goal: External Ids for this goal

  • Consent: Identifier for this record (external references)

  • DocumentReference: Master Version Specific Identifier

  • SupplyRequest: Unique identifier

  • RiskAssessment: Unique identifier for the assessment

  • CareTeam: External Ids for this team

  • ImagingStudy: Other identifiers for the Study

  • FamilyMemberHistory: A search by a record identifier

  • Encounter: Identifier(s) by which this encounter is known

  • DeviceRequest: Business identifier for request/order

  • AllergyIntolerance: External ids for this item

  • CarePlan: External Ids for this plan

  • EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare

  • Procedure: A unique identifier for a procedure

  • List: Business identifier

  • Immunization: Business identifier

  • VisionPrescription: Return prescriptions with this external identifier

  • ProcedureRequest: Identifiers assigned to this order

  • Observation: The unique id for a particular observation

  • DiagnosticReport: An identifier for the report

  • NutritionOrder: Return nutrition orders with this external identifier

  • Condition: A unique identifier of the condition record

  • Composition: Logical identifier of composition (version-independent)

  • DetectedIssue: Unique id for the detected issue

  • SupplyDelivery: External identifier | | type | string | | Multiple Resources:

  • ReferralRequest: The type of the referral

  • DocumentManifest: Kind of document set

  • DocumentReference: Kind of document (LOINC if possible)

  • Encounter: Specific type of encounter

  • AllergyIntolerance: allergy | intolerance - Underlying mechanism (if known)

  • EpisodeOfCare: Type/class - e.g. specialist referral, disease management

  • Composition: Kind of composition (LOINC if possible) | | class | string | | Categorization of Composition | | confidentiality | string | | As defined by affinity domain | | context | string | | Code(s) that apply to the event being documented | | period | string | | The period covered by the documentation | | related-id | string | | Target of the relationship | | section | string | | Classification of section (recommended) | | status | string | | preliminary | final | amended | entered-in-error | | title | string | | Human Readable name/title | | _format | string | | |

RESPONSES

status: OK

[{&quot;resourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;text&quot;:{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;div&quot;:&quot;\u003cstring\u003e&quot;},&quot;identifier&quot;:{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},&quot;date&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;class&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;confidentiality&quot;:&quot;\u003cstring\u003e&quot;,&quot;subject&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;},&quot;author&quot;:[{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}],&quot;attester&quot;:[{&quot;time&quot;:&quot;\u003cstring\u003e&quot;,&quot;mode&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;party&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}}],&quot;custodian&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;},&quot;event&quot;:[{&quot;code&quot;:[{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]}],&quot;period&quot;:{&quot;start&quot;:&quot;\u003cstring\u003e&quot;,&quot;end&quot;:&quot;\u003cstring\u003e&quot;},&quot;detail&quot;:[{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;}]}],&quot;encounter&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;},&quot;section&quot;:[{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;mode&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;text&quot;:{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;div&quot;:&quot;\u003cstring\u003e&quot;},&quot;orderedBy&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;entry&quot;:[{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;}]}]},{&quot;resourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;text&quot;:{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;div&quot;:&quot;\u003cstring\u003e&quot;},&quot;identifier&quot;:{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},&quot;date&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;class&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;confidentiality&quot;:&quot;\u003cstring\u003e&quot;,&quot;subject&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;},&quot;author&quot;:[{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}],&quot;attester&quot;:[{&quot;time&quot;:&quot;\u003cstring\u003e&quot;,&quot;mode&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;party&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}}],&quot;custodian&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;},&quot;event&quot;:[{&quot;code&quot;:[{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]}],&quot;period&quot;:{&quot;start&quot;:&quot;\u003cstring\u003e&quot;,&quot;end&quot;:&quot;\u003cstring\u003e&quot;},&quot;detail&quot;:[{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;}]}],&quot;encounter&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;},&quot;section&quot;:[{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;mode&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;text&quot;:{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;div&quot;:&quot;\u003cstring\u003e&quot;},&quot;orderedBy&quot;:{&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;entry&quot;:[{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;}]}]}]