Argonaut User Facing Patient List
0.1.0 - CI Build

Argonaut User Facing Patient List - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Argonaut Patient List (Group) Profile

Defining URL:http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist
Version:0.1.0
Name:ArgonautPatientListProfile
Title:Argonaut Patient List (Group) Profile
Status:Active as of 2020-12-10T16:51:15-08:00
Definition:

This profile sets minimum expectations for the Group resource to record, search, and fetch user-facing patient lists.

Publisher:Argonaut Project
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... patientlist-questionnaire 0..1Reference(SDCBaseQuestionnaire)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaire
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: true
... managingEntity S0..1Reference(US Core Practitioner Profile S | US Core Organization Profile S | RelatedPerson | PractitionerRole)Entity that is the custodian of the Group's definition
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... code S1..1CodeableConceptKind of characteristic
Binding: Argonaut Group Characteristic Value Set (extensible)
.... value[x] S1..1Value held by characteristic
..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference S(Any)
.... exclude S1..1booleanGroup includes or excludes
... member S0..*BackboneElementWho or what is in group
.... patientlist-questionnaireresponse 0..1Reference(SDC Questionnaire Response)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaireresponse
.... patientlist-encounter 0..*Reference(US Core Encounter Profile)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-encounter
.... patientlist-appointment 0..*Reference(Appointment)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-appointment
.... entity S1..1Reference(US Core Patient Profile S | Argonaut Patient List (Group) Profile S | US Core Practitioner Profile | PractitionerRole)Reference to the group member
..... reference S1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupGroup of multiple entities
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientlist-questionnaire 0..1Reference(SDCBaseQuestionnaire)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaire
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣI1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... quantity SΣ0..1unsignedIntNumber of members
... managingEntity SΣ0..1Reference(US Core Practitioner Profile S | US Core Organization Profile S | RelatedPerson | PractitionerRole)Entity that is the custodian of the Group's definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: Argonaut Group Characteristic Value Set (extensible)
.... value[x] S1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference S(Any)
.... exclude S1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member SI0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patientlist-questionnaireresponse 0..1Reference(SDC Questionnaire Response)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaireresponse
.... patientlist-encounter 0..*Reference(US Core Encounter Profile)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-encounter
.... patientlist-appointment 0..*Reference(Appointment)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-appointment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(US Core Patient Profile S | Argonaut Patient List (Group) Profile S | US Core Practitioner Profile | PractitionerRole)Reference to the group member
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupGroup of multiple entities
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual ΣI1..1booleanDescriptive or actual
Fixed Value: true
... quantity Σ0..1unsignedIntNumber of members
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... code 1..1CodeableConceptKind of characteristic
Binding: Argonaut Group Characteristic Value Set (extensible)
.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
... member I0..*BackboneElementWho or what is in group
.... entity 1..1Reference(US Core Patient Profile | Argonaut Patient List (Group) Profile)Reference to the group member
..... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... patientlist-questionnaire 0..1Reference(SDCBaseQuestionnaire)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaire
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: true
... managingEntity S0..1Reference(US Core Practitioner Profile S | US Core Organization Profile S | RelatedPerson | PractitionerRole)Entity that is the custodian of the Group's definition
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... code S1..1CodeableConceptKind of characteristic
Binding: Argonaut Group Characteristic Value Set (extensible)
.... value[x] S1..1Value held by characteristic
..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference S(Any)
.... exclude S1..1booleanGroup includes or excludes
... member S0..*BackboneElementWho or what is in group
.... patientlist-questionnaireresponse 0..1Reference(SDC Questionnaire Response)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaireresponse
.... patientlist-encounter 0..*Reference(US Core Encounter Profile)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-encounter
.... patientlist-appointment 0..*Reference(Appointment)Extension
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-appointment
.... entity S1..1Reference(US Core Patient Profile S | Argonaut Patient List (Group) Profile S | US Core Practitioner Profile | PractitionerRole)Reference to the group member
..... reference S1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupGroup of multiple entities
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patientlist-questionnaire 0..1Reference(SDCBaseQuestionnaire)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaire
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣI1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... quantity SΣ0..1unsignedIntNumber of members
... managingEntity SΣ0..1Reference(US Core Practitioner Profile S | US Core Organization Profile S | RelatedPerson | PractitionerRole)Entity that is the custodian of the Group's definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: Argonaut Group Characteristic Value Set (extensible)
.... value[x] S1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference S(Any)
.... exclude S1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member SI0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patientlist-questionnaireresponse 0..1Reference(SDC Questionnaire Response)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-questionnaireresponse
.... patientlist-encounter 0..*Reference(US Core Encounter Profile)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-encounter
.... patientlist-appointment 0..*Reference(Appointment)Optional Extensions Element
URL: http://www.fhir.org/guides/argonaut/patient-list/StructureDefinition/patientlist-appointment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(US Core Patient Profile S | Argonaut Patient List (Group) Profile S | US Core Practitioner Profile | PractitionerRole)Reference to the group member
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Group.languagepreferredCommonLanguages
Max Binding: AllLanguages
Group.typerequiredFixed Value: person
Group.codeexample
Group.managingEntity.typeextensibleResourceType
Group.characteristic.codeextensibleArgonautGroupCharacteristicValueSet
Group.characteristic.value[x]example
Group.member.entity.typeextensibleResourceType