{"id":42044098,"url":"https://github.com/lsgs/redcap-instance-select","last_synced_at":"2026-01-26T06:05:28.593Z","repository":{"id":54984710,"uuid":"241281461","full_name":"lsgs/redcap-instance-select","owner":"lsgs","description":"Action tags for converting a text field into a dropdown list of project records, or repeating event/form instances.","archived":false,"fork":false,"pushed_at":"2025-05-01T02:05:10.000Z","size":227,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-01T03:19:52.682Z","etag":null,"topics":["mcri","murdoch-childrens","redcap","redcap-external-module","redcap-repo"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lsgs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-18T05:36:47.000Z","updated_at":"2025-05-01T02:03:37.000Z","dependencies_parsed_at":"2022-08-14T08:10:37.215Z","dependency_job_id":"4a3ccc46-c1f7-4584-904f-c08f43841293","html_url":"https://github.com/lsgs/redcap-instance-select","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/lsgs/redcap-instance-select","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lsgs%2Fredcap-instance-select","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lsgs%2Fredcap-instance-select/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lsgs%2Fredcap-instance-select/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lsgs%2Fredcap-instance-select/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lsgs","download_url":"https://codeload.github.com/lsgs/redcap-instance-select/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lsgs%2Fredcap-instance-select/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28768051,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T03:54:34.369Z","status":"ssl_error","status_checked_at":"2026-01-26T03:54:33.031Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mcri","murdoch-childrens","redcap","redcap-external-module","redcap-repo"],"created_at":"2026-01-26T06:05:26.878Z","updated_at":"2026-01-26T06:05:28.584Z","avatar_url":"https://github.com/lsgs.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# REDCap External Module: Instance Select\n\n`@FORMINSTANCE`, `@EVENTINSTANCE` and `@RECORDINSTANCE` action tags for use with unvalidated text fields that enable you to select a specific instance of a repeating form or event for the current record, or another record from the project.\n\nWhen the data entry or survey page loads, a tagged text field will be replaced with a select list with options for each instance of the specified form / event for the current record, or project records.\n\n## Action Tags\n\n### `@FORMINSTANCE`\n\nSpecify a form name or unique event name/form name pair and the select list will show instances of the specified form for the current record:\n\n* `@FORMINSTANCE=myformname` : Select an instance of `myformname` from all events in which it is designated\n* `@FORMINSTANCE=myevent_arm_1.myformname` : Select an instance of `myformname` from the `myevent_arm_1` event only\n\nIf the (event/)form is not a repeating form then the action tag will be ignored and you will see only the unvalidated text field.\n\n### `@EVENTINSTANCE`\n\nSpecify the unique event name of a repeating event and the select list will show instances of the specified event for the current record:\n\n* `@EVENTINSTANCE=myeventname_arm_n` : Select an instance of repeating event `myeventname_arm_n`\n\nIf the event is not a repeating event then the action tag will be ignored and you will see only the unvalidated text field.\n\n### `@RECORDINSTANCE`\n\nSelect another record from the current project. A comma-separated list of arm numbers may be specified, if desired:\n\n* `@RECORDINSTANCE` : Select a record from the current arm\n* `@RECORDINSTANCE='2,3'` or,\n* `@RECORDINSTANCE=2,3` : Select a record from arm 2 and arm 3 records\n\nInvalid arm numbers will be ignored.\n\nUsers assigned to a DAG will see only records assigned to the same DAG.\n\n### `@INSTANCESELECT-AUTOCOMPLETE`\n\nUse alongside one of the other Instance Select module action tags to have the dropdown list of instances rendered as an auto-complete list rather than a regular select list.\n\n## Custom Labels\n\nIf a custom record label, custom event labels and/or repeat instance labels are configured for the project then the select lists will display instances labelled accordingly.\n\nWhere no labels are configured you will see just the record id or instance reference (see note about instance references below).\n\n### `@RECORDINSTANCE` in a Survey\n\nWhen using `@RECORDINSTANCE` in a survey, records will not be labelled using the project's custom record label - only record ids will be displayed in the select list. This is to guard against participant-identifying data (PHI) that might be included within custom record labels from being displayed to other participants.\n\n## Saved Data\n\nIn general the data saved to the tagged field will be simply a record id or instance number. Sometimes, however, this will not be sufficient to unambiguously identify a single record or form instance. Examples are:\n* `@RECORDINSTANCE` not specifying a single arm in a project with multiple arms \n* `@FORMINSTANCE` specified with a form that is repeating in more than one event\n\nIn these cases the select list values, and hence saved data values, will use the following period-separated patterns:\n\n* `@RECORDINSTANCE` `arm num.record id` e.g. 2.1001\n* `@FORMINSTANCE` `event ref.form instance number` e.g. event_1_arm_1.4\n\nIt is these saved values that will appear in reports and exports. Values will not be labelled with custom record, event or instance labels.\n\nNote: Prior to v2.0.0 a colon was used as the separator, but a colon is not a valid character for a REDCap choice field value. Version 2.0.0 will seamlessly convert values with a colon separator to use a period separator where necessary.\n\n## Example \nThis example shows a project illustrating the @EVENTINSTANCE and @FORMINSTANCE action tags. The project records are individuals that have a number associated people: \"family\" (recorded on the \"Associated Person\" form in the \"Family\" event) and \"friends\" (recorded on the \"Associated Person\" form in the \"Friends\" event). There is also a repeating event with an event form. Calls associated with the people or events are recorded in the \"Call\" form of the \"Calls\" event. The following action tag usage is illustrated:\n* Field calleventinstance; `@EVENTINSTANCE=event_1_arm_1`\n  Select an instance of the repeating `event_1_arm_1` event. \n* Field callfamilyinstance; `@FORMINSTANCE=family_arm_1.associated_person`\n  Select an instance of the a family member from the \"Family\" event.\n* Field callfriendinstance; `@FORMINSTANCE=friend_arm_1.associated_person`\n  Select an instance of the a friend from the \"Friends\" event.\n* Field callfamilyorfriendinstance; `@FORMINSTANCE=associated_person`\n  Select an instance of the \"Associated Person\" form from any event - either \"Family\" or \"Friends\".\n\n![@INSTANCESELECT example](./instance-select.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flsgs%2Fredcap-instance-select","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flsgs%2Fredcap-instance-select","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flsgs%2Fredcap-instance-select/lists"}