SaraAlert - Local Development build (v1.0.0). See the Directory of published versions
Resource Profile: Sara Alert RelatedPerson Profile
| Defining URL: | http://saraalert.org/StructureDefinition/sara-alert-related-person |
| Version: | 1.0.0 |
| Name: | SaraAlertRelatedPerson |
| Title: | Sara Alert RelatedPerson Profile |
| Status: | Active as of 2021-12-01T10:26:21-05:00 |
| Definition: | The Sara Alert RelatedPerson profile represents a close contact of a monitoree. |
| Publisher: | The MITRE Corporation |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://saraalert.org/StructureDefinition/sara-alert-related-person
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Extensions
This structure refers to these extensions:
- http://saraalert.org/StructureDefinition/last-date-of-exposure
- http://saraalert.org/StructureDefinition/assigned-user
- http://saraalert.org/StructureDefinition/notes
- http://saraalert.org/StructureDefinition/contact-attempts
- http://saraalert.org/StructureDefinition/enrolled-patient
- http://saraalert.org/StructureDefinition/created-at
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 last-date-of-exposure | S | 0..1 | date | Last Date of Exposure URL: http://saraalert.org/StructureDefinition/last-date-of-exposure |
| assigned-user | S | 0..1 | positiveInt | Assigned User URL: http://saraalert.org/StructureDefinition/assigned-user |
| notes | S | 0..1 | string | Notes URL: http://saraalert.org/StructureDefinition/notes |
| contact-attempts | S | 0..1 | unsignedInt | Contact Attempts URL: http://saraalert.org/StructureDefinition/contact-attempts |
| enrolled-patient | S | 0..1 | Reference(Patient) | Enrolled Patient URL: http://saraalert.org/StructureDefinition/enrolled-patient |
| created-at | S | 0..1 | dateTime | Created At URL: http://saraalert.org/StructureDefinition/created-at |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
  patient | SΣ | 1..1 | Reference(Patient) | The patient this person is related to |
 id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
 display | Σ | 0..1 | string | Text alternative for the resource |
| relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| name | SΣI | 1..1 | HumanName | A name associated with the person sara-3: At least one name should be given for identification. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 0..1 | string | Family name (often called 'Surname') |
| given | Σ | 0..1 | string | First name This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| telecom | SΣ | 1..2 | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date on which the related person was born |
| address | Σ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
 communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
This structure is derived from RelatedPerson
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Extensions
This structure refers to these extensions:
- http://saraalert.org/StructureDefinition/last-date-of-exposure
- http://saraalert.org/StructureDefinition/assigned-user
- http://saraalert.org/StructureDefinition/notes
- http://saraalert.org/StructureDefinition/contact-attempts
- http://saraalert.org/StructureDefinition/enrolled-patient
- http://saraalert.org/StructureDefinition/created-at
Differential View
This structure is derived from RelatedPerson
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| last-date-of-exposure | S | 0..1 | date | Last Date of Exposure URL: http://saraalert.org/StructureDefinition/last-date-of-exposure |
| assigned-user | S | 0..1 | positiveInt | Assigned User URL: http://saraalert.org/StructureDefinition/assigned-user |
| notes | S | 0..1 | string | Notes URL: http://saraalert.org/StructureDefinition/notes |
| contact-attempts | S | 0..1 | unsignedInt | Contact Attempts URL: http://saraalert.org/StructureDefinition/contact-attempts |
| enrolled-patient | S | 0..1 | Reference(Patient) | Enrolled Patient URL: http://saraalert.org/StructureDefinition/enrolled-patient |
| created-at | S | 0..1 | dateTime | Created At URL: http://saraalert.org/StructureDefinition/created-at |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
| patient | SΣ | 1..1 | Reference(Patient) | The patient this person is related to |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| name | SΣI | 1..1 | HumanName | A name associated with the person sara-3: At least one name should be given for identification. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 0..1 | string | Family name (often called 'Surname') |
| given | Σ | 0..1 | string | First name This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| telecom | SΣ | 1..2 | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date on which the related person was born |
| address | Σ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| RelatedPerson.language | preferred | CommonLanguages Max Binding: AllLanguages |
| RelatedPerson.patient.type | extensible | ResourceType |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
| RelatedPerson.name.use | required | NameUse |
| RelatedPerson.gender | required | AdministrativeGender |
| RelatedPerson.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
Constraints
| Id | Path | Details | Requirements |
| dom-2 | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | RelatedPerson.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:last-date-of-exposure | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:last-date-of-exposure | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:assigned-user | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:assigned-user | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:notes | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:notes | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:contact-attempts | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:contact-attempts | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:enrolled-patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:enrolled-patient | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.extension:created-at | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension:created-at | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.patient.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.patient.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.patient.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| sara-3 | RelatedPerson.name | At least one name should be given for identification. : (family | given).exists() | |
| ele-1 | RelatedPerson.name.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.name.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.name.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name.suffix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |